diff options
| author | David Göransson <david.goransson90@gmail.com> | 2023-09-01 13:26:31 +0200 |
|---|---|---|
| committer | Albin <albin@mullvad.net> | 2023-09-13 17:27:46 +0200 |
| commit | 72aea45577d1247678da43c8f7dbd6fe3e33faa7 (patch) | |
| tree | 9789bd842dfc9fe22947b75daa81a0c63bb3913e /android/BuildInstructions.md | |
| parent | 40297a85e9eec7ff65727f859095c99fee4f7699 (diff) | |
| download | mullvadvpn-72aea45577d1247678da43c8f7dbd6fe3e33faa7.tar.xz mullvadvpn-72aea45577d1247678da43c8f7dbd6fe3e33faa7.zip | |
Update android build instructions for macOS
Diffstat (limited to 'android/BuildInstructions.md')
| -rw-r--r-- | android/BuildInstructions.md | 39 |
1 files changed, 11 insertions, 28 deletions
diff --git a/android/BuildInstructions.md b/android/BuildInstructions.md index 56bac698f1..0c4af11aad 100644 --- a/android/BuildInstructions.md +++ b/android/BuildInstructions.md @@ -17,6 +17,9 @@ the Gradle CLI or the Android Studio GUI. ## Build with provided container (recommended) +> __*NOTE:*__ Build with provided container is only supported on Linux and may not work on other +> platforms. + Building both the native libraries and Android project can easily be achieved by running the [containerized-build.sh](../building/containerized-build.sh) script, which helps using the correct tag and mounting volumes. The script relies on [podman](https://podman.io/getting-started/installation.html) @@ -54,14 +57,17 @@ directory configured in step 1: ../building/containerized-build.sh android --app-bundle ``` -## Build without* the provided container (not recommended) +## Build without* the provided container + +> __*NOTE:*__ This guide is only supported on Linux and may not work on other platforms, if you are +> using macOS please refer to [macOS build instructions](./docs/BuildInstructions.macos.md) Building without the provided container requires installing multiple Sdk:s and toolchains, and is -therefore not recommended. +therefore more complex. -*: A container is still used to build `wireguard-go` for Android since it requires a patched version -of `go`. See [this patch](https://git.zx2c4.com/wireguard-android/tree/tunnel/tools/libwg-go/goruntime-boottime-over-monotonic.diff) -for more information. +> __*\*:*__ A container is still used to build `wireguard-go` for Android since it requires a +> patched version of `go`. See [this patch](https://git.zx2c4.com/wireguard-android/tree/tunnel/tools/libwg-go/goruntime-boottime-over-monotonic.diff) +> for more information. ### Setup build environment These steps explain how to manually setup the build environment on a Linux system. @@ -83,18 +89,10 @@ Linux distro: - Install the JDK - **Linux** - ```bash sudo apt install zip openjdk-17-jdk ``` - **macOS** - - ```bash - brew install openjdk@17 - ``` - - Install the SDK The SDK should be placed in a separate directory, like for example `~/android` or `/opt/android`. @@ -134,24 +132,9 @@ Linux distro: - Configure Android cross-compilation targets and set up linker and archiver. This can be done by setting the following environment variables: - **Linux** - Add to `~/.bashrc` or equivalent: ``` export NDK_TOOLCHAIN_DIR="$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin" - ``` - - **macOS** - - Add to `~/.zshrc` or equivalent: - ``` - export NDK_TOOLCHAIN_DIR="$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/darwin-x86_64/bin" - ``` - - **Both platforms** - - Add the following to the same file as above: - ``` export AR_aarch64_linux_android="$NDK_TOOLCHAIN_DIR/llvm-ar" export AR_armv7_linux_androideabi="$NDK_TOOLCHAIN_DIR/llvm-ar" export AR_x86_64_linux_android="$NDK_TOOLCHAIN_DIR/llvm-ar" |