diff options
| author | Albin <albin@mullvad.net> | 2023-01-19 08:34:12 +0100 |
|---|---|---|
| committer | Albin <albin@mullvad.net> | 2023-01-19 09:36:20 +0100 |
| commit | eb59baa5963e3738cbc1507e98bc7f431c45acb2 (patch) | |
| tree | 313142b7a2e1a03fe07eccff2658272b449f5a34 /android | |
| parent | 6d09bea1630af7858d25d90d2933a953e8394b99 (diff) | |
| download | mullvadvpn-eb59baa5963e3738cbc1507e98bc7f431c45acb2.tar.xz mullvadvpn-eb59baa5963e3738cbc1507e98bc7f431c45acb2.zip | |
Add quick start section to android readme
Diffstat (limited to 'android')
| -rw-r--r-- | android/README.md | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/android/README.md b/android/README.md index a57d3bfc56..05bee5ad4b 100644 --- a/android/README.md +++ b/android/README.md @@ -5,9 +5,21 @@ content of this directory, the Android project also relies on [wireguard-go](../ [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 |