diff options
| author | Albin <albin@mullvad.net> | 2023-01-19 10:07:07 +0100 |
|---|---|---|
| committer | Albin <albin@mullvad.net> | 2023-01-19 10:07:07 +0100 |
| commit | fd5b7551cdbbb9225d2d41a9951b2a5a1b528301 (patch) | |
| tree | 313142b7a2e1a03fe07eccff2658272b449f5a34 | |
| parent | 5686f9fd331f29b71164feca5b43a092c4d1f659 (diff) | |
| parent | eb59baa5963e3738cbc1507e98bc7f431c45acb2 (diff) | |
| download | mullvadvpn-fd5b7551cdbbb9225d2d41a9951b2a5a1b528301.tar.xz mullvadvpn-fd5b7551cdbbb9225d2d41a9951b2a5a1b528301.zip | |
Merge branch 'improve-android-readme-intro-and-quick-start'
| -rw-r--r-- | android/README.md | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/android/README.md b/android/README.md index b840c9d01d..05bee5ad4b 100644 --- a/android/README.md +++ b/android/README.md @@ -1,10 +1,25 @@ # Mullvad VPN Android app -This directory contains the files specific to the Android app. +This directory contains the Android project as well as related files and information. Apart from the +content of this directory, the Android project also relies on [wireguard-go](../wireguard/) and the +[mullvad-daemon](../mullvad-daemon/) which are both bundled as shared libraries into the assembled +APK. -## Building the app +## Quick start -See the [build instructions](BuildInstructions.md) for help building the app. +### Browsing the source code + +The content in this directory (`<repository-root>/android`) follows a standard Android project +structure and can therefore be opened in Android Studio or any other IDE or editor of your choice. + +### Building the app + +The easiest and recommended way to build the Android project including the `mullvad-daemon` and +`wireguard-go` is to use the following command (which requires `podman`): +``` +../building/containerized-build.sh android --dev-build +``` +See the [build instructions](BuildInstructions.md) for further information. ## Translations / Localization |