Merge pull request #9425 from aaronfranke/compile-android-doc

Improve Compiling for Android and Compiling for iOS docs
This commit is contained in:
Max Hilbrunner
2024-05-30 17:29:08 +02:00
committed by GitHub
2 changed files with 21 additions and 8 deletions

View File

@@ -32,8 +32,8 @@ For compiling under Windows, Linux or macOS, the following is required:
(command-line tools are sufficient). (command-line tools are sufficient).
- Required SDK components will be automatically installed. - Required SDK components will be automatically installed.
- On Linux, - On Linux, **do not use an Android SDK provided by your distribution's repositories** as it will often be outdated.
**do not use an Android SDK provided by your distribution's repositories as it will often be outdated**. - On macOS, **do not use an Android SDK provided by Homebrew** as it will not be installed in a unified location.
- Gradle (will be downloaded and installed automatically if missing). - Gradle (will be downloaded and installed automatically if missing).
- JDK 17 (either OpenJDK or Oracle JDK). - JDK 17 (either OpenJDK or Oracle JDK).
@@ -55,6 +55,14 @@ Setting up the buildsystem
SDK. If you downloaded the Android command-line tools, this would be SDK. If you downloaded the Android command-line tools, this would be
the folder where you extracted the contents of the ZIP archive. the folder where you extracted the contents of the ZIP archive.
- Windows: Press :kbd:`Windows + R`, type "control system",
then click on **Advanced system settings** in the left pane,
then click on **Environment variables** on the window that appears.
- Linux or macOS: Add the text ``export ANDROID_HOME="/path/to/android-sdk"``
to your ``.bashrc`` or ``.zshrc`` where ``/path/to/android-sdk`` points to
the root of the SDK directories.
- Install the necessary SDK components in this folder: - Install the necessary SDK components in this folder:
- Accept the SDK component licenses by running the following command - Accept the SDK component licenses by running the following command
@@ -70,13 +78,14 @@ Setting up the buildsystem
cmdline-tools/latest/bin/sdkmanager --sdk_root=<android_sdk_path> "platform-tools" "build-tools;34.0.0" "platforms;android-34" "cmdline-tools;latest" "cmake;3.10.2.4988404" "ndk;23.2.8568313" cmdline-tools/latest/bin/sdkmanager --sdk_root=<android_sdk_path> "platform-tools" "build-tools;34.0.0" "platforms;android-34" "cmdline-tools;latest" "cmake;3.10.2.4988404" "ndk;23.2.8568313"
.. seealso:: To set the environment variable on Windows, press :kbd:`Windows + R`, type - After setting up the SDK and environment variables, be sure to
"control system", then click on **Advanced system settings** in the left **restart your terminal** to apply the changes. If you are using
pane, then click on **Environment variables** on the window that appears. an IDE with an integrated terminal, you need to restart the IDE.
.. seealso:: To set the environment variable on Linux or macOS, use - Run ``scons platform=android``. If this fails, go back and check the steps.
``export ANDROID_HOME=/path/to/android-sdk`` where ``/path/to/android-sdk`` points to If you completed the setup correctly, the NDK will begin downloading.
the root of the SDK directories. If you are trying to compile GDExtension, you need to first compile
the engine to download the NDK, then you can compile GDExtension.
Building the export templates Building the export templates
----------------------------- -----------------------------

View File

@@ -16,6 +16,10 @@ Requirements
- `Python 3.6+ <https://www.python.org/downloads/macos/>`_. - `Python 3.6+ <https://www.python.org/downloads/macos/>`_.
- `SCons 3.1.2+ <https://scons.org/pages/download.html>`_ build system. - `SCons 3.1.2+ <https://scons.org/pages/download.html>`_ build system.
- `Xcode <https://apps.apple.com/us/app/xcode/id497799835>`_. - `Xcode <https://apps.apple.com/us/app/xcode/id497799835>`_.
- Launch Xcode once and install iOS support. If you have already launched
Xcode and need to install iOS support, go to *Xcode -> Settings... -> Platforms*.
- Go to *Xcode -> Settings... -> Locations -> Command Line Tools* and select
an installed version. Even if one is already selected, re-select it.
If you are building the ``master`` branch: If you are building the ``master`` branch: