diff --git a/docs/CROWDIN/cs/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/cs/Maintenance/DocumentationUpdate.md index adef55e8a685..06072b4c527d 100644 --- a/docs/CROWDIN/cs/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/cs/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/cs/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/cs/Maintenance/UpdateComputerBuild.md index be68ba5cda2b..9df19e0466c8 100644 --- a/docs/CROWDIN/cs/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/cs/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Vyrobte si místo stažení @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/cs/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/cs/Maintenance/UpdateToNewVersion.md index 2647e7e07cf9..8987836e2b4e 100644 --- a/docs/CROWDIN/cs/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/cs/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Zkontrolujte verzi AAPS na telefonu diff --git a/docs/CROWDIN/cs/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/cs/SettingUpAaps/BuildingAaps.md index 7d75a0752378..5685ae7e5e35 100644 --- a/docs/CROWDIN/cs/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/cs/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/cs/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/cs/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..68fed127b7ed --- /dev/null +++ b/docs/CROWDIN/cs/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Požadavky + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/cs/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/cs/SettingUpAaps/ComputerBuild.md index e73de34e96dd..f70718a9e343 100644 --- a/docs/CROWDIN/cs/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/cs/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/cs/index.md b/docs/CROWDIN/cs/index.md index c72efd509080..f05ee905532c 100644 --- a/docs/CROWDIN/cs/index.md +++ b/docs/CROWDIN/cs/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/de/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/de/Maintenance/DocumentationUpdate.md index 9f1f63c4f2ac..d838cb63e0fb 100644 --- a/docs/CROWDIN/de/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/de/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs Updates & Änderungen +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## Januar 2025 - [3.4](#version3400) Veröffentlichung und Dokumentation aktualisiert Roll-up (Einrichtungsasssistent, Computer Build-Versionen, Konfiguration) diff --git a/docs/CROWDIN/de/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/de/Maintenance/UpdateComputerBuild.md index 773db341d62f..8c20c279c49f 100644 --- a/docs/CROWDIN/de/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/de/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Mit einem PC/Computer aktualisieren +# Update with Android Studio ## Kein Download möglich - APK muss selbst erstellt werden @@ -8,7 +8,7 @@ Aufgrund der gesetzlichen Regelungen für Medizinprodukte ist **AAPS** nicht als Falls Du **AAPS** auf einem neuen Computer erstellen möchtest: Kopiere das Backup Deiner Keystore-Datei auf den neuen Computer. Folge dann dem [Prozess für die erstmalige **AAPS**-Erstellung](../SettingUpAaps/BuildingAaps.md) und nicht dieser Anleitung. Der einzige Unterschied besteht darin, dass Du anstelle einen neuen Keystore zu erstellen, den Keystore auswählst, den Du auf den neuen Computer kopiert hast. ``` -## Übersicht zur Aktualisierung auf eine neue AAPS-Version mit einem Computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/de/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/de/Maintenance/UpdateToNewVersion.md index c9737641067c..a00667d93ea8 100644 --- a/docs/CROWDIN/de/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/de/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ Aufgrund der gesetzlichen Regelungen für Medizinprodukte ist **AAPS** nicht als Wenn Du die AAPS-App bereits mit der Browser-Build-Methode erstellt hast, befolge [diesen Anweisungen](./UpdateBrowserBuild.md). -## AAPS mit einem Computer aktualisieren +## Update AAPS with Android Studio Nutze [diese Anleitung](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### AAPS-Version auf dem Smartphone überprüfen diff --git a/docs/CROWDIN/de/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/de/SettingUpAaps/BuildingAaps.md index 2c50cb6416fa..4ece18007f20 100644 --- a/docs/CROWDIN/de/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/de/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ Zu den Details schaue bitte auf die [FAQ-Seite](../UsefulLinks/FAQ.md). --- -Die AAPS-App kann auf zwei Wegen erstellt werden: +Three methods are available to build the AAPS app: -### Mit einem Browser erstellen +### Build with a browser (recommended) Du kannst die App mit Deinem Smartphone und entsprechenden GitHub-Aktionen erstellen und in Deinem Google Drive speichern. @@ -18,9 +18,16 @@ Du kannst die App mit Deinem Smartphone und entsprechenden GitHub-Aktionen erste ---- -### Mit einem Computer erstellen +### Build with Android Studio -Du kannst die App mit Deinem Computer und dem „Android Studio“ erstellen. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Nutze diese Anleitung.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Nutze diese Anleitung.](./CLIBuild.md)** diff --git a/docs/CROWDIN/de/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/de/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..b82dccda2722 --- /dev/null +++ b/docs/CROWDIN/de/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Voraussetzungen + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/de/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/de/SettingUpAaps/ComputerBuild.md index b245483897a3..c0c0be720bee 100644 --- a/docs/CROWDIN/de/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/de/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build Dies ist die herkömmliche Methode, um Deine AAPS-App zu erstellen. diff --git a/docs/CROWDIN/de/index.md b/docs/CROWDIN/de/index.md index 2a2fa08767c1..60f032aecb9a 100644 --- a/docs/CROWDIN/de/index.md +++ b/docs/CROWDIN/de/index.md @@ -84,21 +84,22 @@ Komponentenübersicht <./Getting-Started/ComponentOverview.md> ``` ```{toctree} -:caption: 3) AAPS +:caption: 3) Setting up AAPS -Einrichten des Berichtsservers <./SettingUpAaps/SettingUpTheReportingServer.md> +Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Nightscout <./SettingUpAaps/Nightscout.md> - Tidepool <./SettingUpAaps/Tidepool.md> -AAPS erstellen <./SettingUpAaps/BuildingAaps.md> -- Im Browser (Browser Build) <./SettingUpAaps/BrowserBuild.md> -- Mit dem Computer (Computer Build) <./SettingUpAaps/ComputerBuild.md> -AAPS übertragen und installieren <./SettingUpAaps/TransferringAndInstallingAaps.md> -Einrichtungsassistent <./SettingUpAaps/SetupWizard.md> -Dein AAPS-Profil <. SettingUpAaps/YourAapsProfile.md> -Ändern der AAPS-Konfiguration <./SettingUpAaps/ChangeAapsConfiguration.md> -- Konfiguation <./SettingUpAaps/ConfigBuilder.md> -- Einstellungen <./SettingUpAaps/Preferences.md> -Abschluss der Ziele <./SettingUpAaps/CompletingTheObjectives.md> +Building AAPS <./SettingUpAaps/BuildingAaps.md> +- Browser Build <./SettingUpAaps/BrowserBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> +Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> +Setup Wizard <./SettingUpAaps/SetupWizard.md> +Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> +Change AAPS configuration <./SettingUpAaps/ChangeAapsConfiguration.md> +- Config Builder <./SettingUpAaps/ConfigBuilder.md> +- Preferences <./SettingUpAaps/Preferences.md> +Completing the objectives <./SettingUpAaps/CompletingTheObjectives.md> ``` ```{toctree} @@ -141,15 +142,15 @@ Austausch-Plattform für eigene Zifferblätter <./ExchangeSiteCustomWatchfaces/i ``` ```{toctree} -:caption: 7) AAPS pflegen +:caption: 7) Maintenance of AAPS -Export/Import der Einstellungen <./Maintenance/ExportImporteinstellungen. d> -Deine Daten prüfen <./Maintenance/Reviewing.md> +Export/Import Settings <./Maintenance/ExportImportSettings.md> +Reviewing your data <./Maintenance/Reviewing.md> AAPS Release Notes <./Maintenance/ReleaseNotes.md> -Dokumentation aktualisieren <. Maintenance/DocumentationUpdate.md> -Update auf eine neue AAPS-Version <./Maintenance/UpdateToNewVersion. d> -- Browser-Update <./Maintenance/UpdateBrowserBuild.md> -- Computer-Update <./Maintenance/UpdateComputerBuild.md> +Documentation updates <./Maintenance/DocumentationUpdate.md> +Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> +- Browser Update <./Maintenance/UpdateBrowserBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/el/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/el/Maintenance/DocumentationUpdate.md index e474b7f79529..15db54ffc0ab 100644 --- a/docs/CROWDIN/el/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/el/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/el/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/el/Maintenance/UpdateComputerBuild.md index 05f9f95147af..2c6c56fb37a4 100644 --- a/docs/CROWDIN/el/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/el/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Φτιάξτε το μόνοι σας, αντί να το κατεβάσετε @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/el/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/el/Maintenance/UpdateToNewVersion.md index 2c0aec79a676..fbd3341d4789 100644 --- a/docs/CROWDIN/el/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/el/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Ελέγξτε την έκδοση AAPS στο τηλέφωνό σας diff --git a/docs/CROWDIN/el/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/el/SettingUpAaps/BuildingAaps.md index 5989cf3fd8b9..6c2691f4372b 100644 --- a/docs/CROWDIN/el/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/el/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/el/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/el/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/el/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/el/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/el/SettingUpAaps/ComputerBuild.md index f1f49fcdbfba..8e8be37f5ef5 100644 --- a/docs/CROWDIN/el/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/el/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/el/index.md b/docs/CROWDIN/el/index.md index dc94e2ec251d..fddd4437fb91 100644 --- a/docs/CROWDIN/el/index.md +++ b/docs/CROWDIN/el/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/es/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/es/Maintenance/DocumentationUpdate.md index 5a195f068c15..0b03c3e2cd5c 100644 --- a/docs/CROWDIN/es/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/es/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/es/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/es/Maintenance/UpdateComputerBuild.md index f3200a487103..f999f48368c1 100644 --- a/docs/CROWDIN/es/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/es/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Construyela tú mismo en lugar de descargarla @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/es/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/es/Maintenance/UpdateToNewVersion.md index 915c5254614f..e59d04226235 100644 --- a/docs/CROWDIN/es/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/es/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Check AAPS version on phone diff --git a/docs/CROWDIN/es/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/es/SettingUpAaps/BuildingAaps.md index 074775982d70..15bee0aecc60 100644 --- a/docs/CROWDIN/es/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/es/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/es/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/es/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/es/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/es/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/es/SettingUpAaps/ComputerBuild.md index 6cbd8eea178d..e78788a05a00 100644 --- a/docs/CROWDIN/es/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/es/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/es/index.md b/docs/CROWDIN/es/index.md index 9537cdb435c0..45a75efa370d 100644 --- a/docs/CROWDIN/es/index.md +++ b/docs/CROWDIN/es/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/fr/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/fr/Maintenance/DocumentationUpdate.md index 0b35c1984fe1..2e734158cec1 100644 --- a/docs/CROWDIN/fr/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/fr/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Mises à jour et modifications de la documentation +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/fr/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/fr/Maintenance/UpdateComputerBuild.md index 7569ab1eafc8..a9babc8bec8b 100644 --- a/docs/CROWDIN/fr/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/fr/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Construire vous-même au lieu de télécharger @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/fr/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/fr/Maintenance/UpdateToNewVersion.md index 48c963b02bac..0c1a706ee703 100644 --- a/docs/CROWDIN/fr/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/fr/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Vérifier la version d'AAPS sur le téléphone diff --git a/docs/CROWDIN/fr/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/fr/SettingUpAaps/BuildingAaps.md index 4015249c0ff8..eb737e467bfb 100644 --- a/docs/CROWDIN/fr/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/fr/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/fr/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/fr/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/fr/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/fr/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/fr/SettingUpAaps/ComputerBuild.md index bd764b42cc36..189f935f244a 100644 --- a/docs/CROWDIN/fr/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/fr/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/fr/index.md b/docs/CROWDIN/fr/index.md index fb09de2f42b0..ddcdfd3b0a92 100644 --- a/docs/CROWDIN/fr/index.md +++ b/docs/CROWDIN/fr/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/he/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/he/Maintenance/DocumentationUpdate.md index 2434bb70c4ed..af134d2d90ac 100644 --- a/docs/CROWDIN/he/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/he/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/he/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/he/Maintenance/UpdateComputerBuild.md index f4e068ee976f..56625cccdda4 100644 --- a/docs/CROWDIN/he/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/he/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## בנייה עצמית במקום הורדה @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/he/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/he/Maintenance/UpdateToNewVersion.md index ce7a47824295..35dad0358740 100644 --- a/docs/CROWDIN/he/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/he/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Check AAPS version on phone diff --git a/docs/CROWDIN/he/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/he/SettingUpAaps/BuildingAaps.md index ea73db89bbfb..07e71aeaf6ed 100644 --- a/docs/CROWDIN/he/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/he/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/he/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/he/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/he/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/he/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/he/SettingUpAaps/ComputerBuild.md index d8fc98c78429..3d0c3a7a54bd 100644 --- a/docs/CROWDIN/he/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/he/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/he/index.md b/docs/CROWDIN/he/index.md index d835fad7c1cb..e44dd32cd554 100644 --- a/docs/CROWDIN/he/index.md +++ b/docs/CROWDIN/he/index.md @@ -94,7 +94,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -152,7 +153,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/ko/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/ko/Maintenance/DocumentationUpdate.md index 8431fe3d39c4..b998a4732100 100644 --- a/docs/CROWDIN/ko/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/ko/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/ko/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/ko/Maintenance/UpdateComputerBuild.md index f550d48cfa80..bd1d22c9948f 100644 --- a/docs/CROWDIN/ko/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/ko/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## 다운로드 대신에 당신 스스로 빌드하세요 @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/ko/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/ko/Maintenance/UpdateToNewVersion.md index 44291479fd40..46f3c4184212 100644 --- a/docs/CROWDIN/ko/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/ko/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Check AAPS version on phone diff --git a/docs/CROWDIN/ko/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/ko/SettingUpAaps/BuildingAaps.md index 195a8f3037de..18c67763e0f0 100644 --- a/docs/CROWDIN/ko/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/ko/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/ko/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/ko/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/ko/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/ko/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/ko/SettingUpAaps/ComputerBuild.md index b83338634ed8..41606bb34b90 100644 --- a/docs/CROWDIN/ko/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/ko/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/ko/index.md b/docs/CROWDIN/ko/index.md index d4f6c178a00c..0050dcb4538a 100644 --- a/docs/CROWDIN/ko/index.md +++ b/docs/CROWDIN/ko/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/lt/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/lt/Maintenance/DocumentationUpdate.md index eacd2b091a86..5ee499fb66a8 100644 --- a/docs/CROWDIN/lt/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/lt/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/lt/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/lt/Maintenance/UpdateComputerBuild.md index 951ea68606c8..ac53106e028c 100644 --- a/docs/CROWDIN/lt/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/lt/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Kurti sau, o ne parsisiųsti @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/lt/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/lt/Maintenance/UpdateToNewVersion.md index a3035061e3fe..7b3e2e38be5e 100644 --- a/docs/CROWDIN/lt/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/lt/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Check AAPS version on phone diff --git a/docs/CROWDIN/lt/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/lt/SettingUpAaps/BuildingAaps.md index de235042c554..6a3f61276159 100644 --- a/docs/CROWDIN/lt/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/lt/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/lt/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/lt/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/lt/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/lt/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/lt/SettingUpAaps/ComputerBuild.md index d9aabdce1926..e34bd73ecbbe 100644 --- a/docs/CROWDIN/lt/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/lt/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/lt/index.md b/docs/CROWDIN/lt/index.md index 14746596938e..2543c6e95760 100644 --- a/docs/CROWDIN/lt/index.md +++ b/docs/CROWDIN/lt/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/nl/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/nl/Maintenance/DocumentationUpdate.md index b97dd89b44af..b4b25fe9e3f8 100644 --- a/docs/CROWDIN/nl/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/nl/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/nl/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/nl/Maintenance/UpdateComputerBuild.md index 31facc9c8d27..53170088fa4b 100644 --- a/docs/CROWDIN/nl/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/nl/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Zelf bouwen, in plaats van downloaden @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/nl/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/nl/Maintenance/UpdateToNewVersion.md index f5016ee083f4..6c3853d335f3 100644 --- a/docs/CROWDIN/nl/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/nl/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Check AAPS version on phone diff --git a/docs/CROWDIN/nl/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/nl/SettingUpAaps/BuildingAaps.md index 2aa06619889f..6922c2b10929 100644 --- a/docs/CROWDIN/nl/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/nl/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/nl/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/nl/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/nl/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/nl/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/nl/SettingUpAaps/ComputerBuild.md index e5175422e172..b2a3de86a016 100644 --- a/docs/CROWDIN/nl/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/nl/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/nl/index.md b/docs/CROWDIN/nl/index.md index fda21e4a6ca5..c34aeafcefc7 100644 --- a/docs/CROWDIN/nl/index.md +++ b/docs/CROWDIN/nl/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/pb/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/pb/Maintenance/DocumentationUpdate.md index bcab53cb3ee4..ccbba16ade7a 100644 --- a/docs/CROWDIN/pb/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/pb/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/pb/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/pb/Maintenance/UpdateComputerBuild.md index 6a55381526f5..5382357cc05a 100644 --- a/docs/CROWDIN/pb/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/pb/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Build yourself instead of download @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/pb/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/pb/Maintenance/UpdateToNewVersion.md index 4a290089964a..bb94b8025194 100644 --- a/docs/CROWDIN/pb/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/pb/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Check AAPS version on phone diff --git a/docs/CROWDIN/pb/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/pb/SettingUpAaps/BuildingAaps.md index aa95e0cf7c3a..97d38551b766 100644 --- a/docs/CROWDIN/pb/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/pb/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/pb/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/pb/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/pb/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/pb/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/pb/SettingUpAaps/ComputerBuild.md index 4a8952c657d8..4a1ec5606bdc 100644 --- a/docs/CROWDIN/pb/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/pb/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/pb/index.md b/docs/CROWDIN/pb/index.md index 20b8f1837d2e..fc583173843e 100644 --- a/docs/CROWDIN/pb/index.md +++ b/docs/CROWDIN/pb/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/pl/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/pl/Maintenance/DocumentationUpdate.md index 70d34e46e43d..92f94fb70aaf 100644 --- a/docs/CROWDIN/pl/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/pl/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/pl/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/pl/Maintenance/UpdateComputerBuild.md index 6a55381526f5..5382357cc05a 100644 --- a/docs/CROWDIN/pl/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/pl/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Build yourself instead of download @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/pl/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/pl/Maintenance/UpdateToNewVersion.md index 17f5f95a3922..eac79f81216c 100644 --- a/docs/CROWDIN/pl/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/pl/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Check AAPS version on phone diff --git a/docs/CROWDIN/pl/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/pl/SettingUpAaps/BuildingAaps.md index aa95e0cf7c3a..97d38551b766 100644 --- a/docs/CROWDIN/pl/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/pl/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/pl/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/pl/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/pl/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/pl/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/pl/SettingUpAaps/ComputerBuild.md index 4a8952c657d8..4a1ec5606bdc 100644 --- a/docs/CROWDIN/pl/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/pl/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/pl/index.md b/docs/CROWDIN/pl/index.md index ecda028b032a..d6aea57e0fa3 100644 --- a/docs/CROWDIN/pl/index.md +++ b/docs/CROWDIN/pl/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/pt/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/pt/Maintenance/DocumentationUpdate.md index b4e3c885049d..68d1fb0ed5f4 100644 --- a/docs/CROWDIN/pt/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/pt/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/pt/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/pt/Maintenance/UpdateComputerBuild.md index 6620c6787f22..d28d6a5c6ac1 100644 --- a/docs/CROWDIN/pt/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/pt/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Construa você em vez de fazer download @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/pt/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/pt/Maintenance/UpdateToNewVersion.md index a3c3e878e440..61814566c361 100644 --- a/docs/CROWDIN/pt/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/pt/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Check AAPS version on phone diff --git a/docs/CROWDIN/pt/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/pt/SettingUpAaps/BuildingAaps.md index 72ad00ea6671..0ebbb3bea115 100644 --- a/docs/CROWDIN/pt/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/pt/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/pt/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/pt/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/pt/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/pt/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/pt/SettingUpAaps/ComputerBuild.md index e2a37b59a096..ed49ddda7e3d 100644 --- a/docs/CROWDIN/pt/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/pt/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/pt/index.md b/docs/CROWDIN/pt/index.md index 16bf4dd80c01..49af20b8bf7e 100644 --- a/docs/CROWDIN/pt/index.md +++ b/docs/CROWDIN/pt/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/ro/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/ro/Maintenance/DocumentationUpdate.md index 0fafd92875ba..fa3b92479baf 100644 --- a/docs/CROWDIN/ro/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/ro/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/ro/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/ro/Maintenance/UpdateComputerBuild.md index 6a55381526f5..5382357cc05a 100644 --- a/docs/CROWDIN/ro/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/ro/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Build yourself instead of download @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/ro/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/ro/Maintenance/UpdateToNewVersion.md index 4a290089964a..bb94b8025194 100644 --- a/docs/CROWDIN/ro/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/ro/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Check AAPS version on phone diff --git a/docs/CROWDIN/ro/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/ro/SettingUpAaps/BuildingAaps.md index aa95e0cf7c3a..97d38551b766 100644 --- a/docs/CROWDIN/ro/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/ro/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/ro/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/ro/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/ro/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/ro/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/ro/SettingUpAaps/ComputerBuild.md index 4a8952c657d8..4a1ec5606bdc 100644 --- a/docs/CROWDIN/ro/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/ro/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/ro/index.md b/docs/CROWDIN/ro/index.md index 20b8f1837d2e..fc583173843e 100644 --- a/docs/CROWDIN/ro/index.md +++ b/docs/CROWDIN/ro/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/ru/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/ru/Maintenance/DocumentationUpdate.md index 2393d3ce6d28..93a97557c984 100644 --- a/docs/CROWDIN/ru/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/ru/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Обновления и изменения в документации +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/ru/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/ru/Maintenance/UpdateComputerBuild.md index fa4c94cb1b3a..28e4a81968f9 100644 --- a/docs/CROWDIN/ru/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/ru/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Постройте сами вместо скачивания @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/ru/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/ru/Maintenance/UpdateToNewVersion.md index 3eb358d27cff..e2598e3f18a3 100644 --- a/docs/CROWDIN/ru/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/ru/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Проверьте версию AAPS на телефоне diff --git a/docs/CROWDIN/ru/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/ru/SettingUpAaps/BuildingAaps.md index bafa701fa0dd..75e0b1360dcc 100644 --- a/docs/CROWDIN/ru/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/ru/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/ru/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/ru/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..b53670a51fc5 --- /dev/null +++ b/docs/CROWDIN/ru/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Что потребуется: + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/ru/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/ru/SettingUpAaps/ComputerBuild.md index 2b251b2236ca..634b38545690 100644 --- a/docs/CROWDIN/ru/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/ru/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/ru/index.md b/docs/CROWDIN/ru/index.md index e81c480cf2f7..e72e15e561e1 100644 --- a/docs/CROWDIN/ru/index.md +++ b/docs/CROWDIN/ru/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/sk/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/sk/Maintenance/DocumentationUpdate.md index 065449ea1893..bfbe3265e77d 100644 --- a/docs/CROWDIN/sk/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/sk/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Docs updates & changes +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/sk/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/sk/Maintenance/UpdateComputerBuild.md index 6a55381526f5..5382357cc05a 100644 --- a/docs/CROWDIN/sk/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/sk/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Build yourself instead of download @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/sk/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/sk/Maintenance/UpdateToNewVersion.md index 4a290089964a..bb94b8025194 100644 --- a/docs/CROWDIN/sk/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/sk/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Check AAPS version on phone diff --git a/docs/CROWDIN/sk/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/sk/SettingUpAaps/BuildingAaps.md index aa95e0cf7c3a..97d38551b766 100644 --- a/docs/CROWDIN/sk/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/sk/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/sk/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/sk/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/sk/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/sk/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/sk/SettingUpAaps/ComputerBuild.md index 4a8952c657d8..4a1ec5606bdc 100644 --- a/docs/CROWDIN/sk/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/sk/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/sk/index.md b/docs/CROWDIN/sk/index.md index 20b8f1837d2e..fc583173843e 100644 --- a/docs/CROWDIN/sk/index.md +++ b/docs/CROWDIN/sk/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/tr/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/tr/Maintenance/DocumentationUpdate.md index 4c42debdf944..418f12bd09c8 100644 --- a/docs/CROWDIN/tr/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/tr/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # Doküman güncellemeleri & değişiklikleri +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## January 2025 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/tr/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/tr/Maintenance/UpdateComputerBuild.md index c3fb4aa8a63c..a585aa154caf 100644 --- a/docs/CROWDIN/tr/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/tr/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## Programı İndirmek yerine kendiniz oluşturun... @@ -8,7 +8,7 @@ In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/tr/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/tr/Maintenance/UpdateToNewVersion.md index 07fe35c4207f..d609f38c7a77 100644 --- a/docs/CROWDIN/tr/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/tr/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### Telefondaki AAPS sürümünü kontrol edin diff --git a/docs/CROWDIN/tr/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/tr/SettingUpAaps/BuildingAaps.md index cfabef8a8ab2..049e5f5741b7 100644 --- a/docs/CROWDIN/tr/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/tr/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ See [FAQ page](../UsefulLinks/FAQ.md) for details. --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/tr/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/tr/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..91bcee48b1db --- /dev/null +++ b/docs/CROWDIN/tr/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## Requirements + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/tr/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/tr/SettingUpAaps/ComputerBuild.md index 4511ebef9d0e..415d9e160fbd 100644 --- a/docs/CROWDIN/tr/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/tr/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/tr/index.md b/docs/CROWDIN/tr/index.md index c133811fc10d..bb39eb8d4cd0 100644 --- a/docs/CROWDIN/tr/index.md +++ b/docs/CROWDIN/tr/index.md @@ -91,7 +91,8 @@ Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Tidepool <./SettingUpAaps/Tidepool.md> Building AAPS <./SettingUpAaps/BuildingAaps.md> - Browser Build <./SettingUpAaps/BrowserBuild.md> -- Computer Build <./SettingUpAaps/ComputerBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> Setup Wizard <./SettingUpAaps/SetupWizard.md> Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> @@ -149,7 +150,7 @@ AAPS Release Notes <./Maintenance/ReleaseNotes.md> Documentation updates <./Maintenance/DocumentationUpdate.md> Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> - Browser Update <./Maintenance/UpdateBrowserBuild.md> -- Computer Update <./Maintenance/UpdateComputerBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/zh_CN/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/zh_CN/Maintenance/DocumentationUpdate.md index 5214572eb4e3..be7c4959c9ae 100644 --- a/docs/CROWDIN/zh_CN/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/zh_CN/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # 文档更新与变更 +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## 2025年1月 - [3.4](#version3400) release and documentation update roll-up (Wizard, Computer build versions, Config Builder) diff --git a/docs/CROWDIN/zh_CN/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/zh_CN/Maintenance/UpdateComputerBuild.md index f39c2e102589..d4b8f22c58ac 100644 --- a/docs/CROWDIN/zh_CN/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/zh_CN/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# Update with a computer +# Update with Android Studio ## 自行构建而非下载 @@ -8,7 +8,7 @@ 如果您想在新电脑上构建 **AAPS**:请将备份的密钥库文件复制到新电脑。 然后按照 [首次构建 **AAPS** 流程](../SettingUpAaps/BuildingAaps.md) 操作,而非本指南。 唯一区别在于您可以选择已复制的密钥库文件而无需新建。 ``` -## Overview for updating to a new version of AAPS with a computer +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/zh_CN/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/zh_CN/Maintenance/UpdateToNewVersion.md index 50841d3f818d..4aa51b99e351 100644 --- a/docs/CROWDIN/zh_CN/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/zh_CN/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ If you already built your AAPS app with the Browser Build method, follow [these instructions](./UpdateBrowserBuild.md). -## Update AAPS with a computer +## Update AAPS with Android Studio Follow [these instructions.](./UpdateComputerBuild.md). +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### 检查手机上的 AAPS 版本 diff --git a/docs/CROWDIN/zh_CN/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/zh_CN/SettingUpAaps/BuildingAaps.md index 7166591ba934..80bb9736de7f 100644 --- a/docs/CROWDIN/zh_CN/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/zh_CN/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ --- -Two methods are available to build the AAPS app: +Three methods are available to build the AAPS app: -### Build with a browser +### Build with a browser (recommended) You can build the app with your smartphone using GitHub actions, and save it in your Google Drive. @@ -18,9 +18,16 @@ You can build the app with your smartphone using GitHub actions, and save it in ---- -### Build with a computer +### Build with Android Studio -You can build the app with your computer using Android Studio. +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[Follow these instructions.](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[Follow these instructions.](./CLIBuild.md)** diff --git a/docs/CROWDIN/zh_CN/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/zh_CN/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..a800e1b69b91 --- /dev/null +++ b/docs/CROWDIN/zh_CN/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## 要求 + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/zh_CN/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/zh_CN/SettingUpAaps/ComputerBuild.md index 62b34b4d776e..69ce06718288 100644 --- a/docs/CROWDIN/zh_CN/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/zh_CN/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# Computer Build + + +# Android Studio Build This is the traditional method to build your AAPS app. diff --git a/docs/CROWDIN/zh_CN/index.md b/docs/CROWDIN/zh_CN/index.md index 45b99e75d5a5..1de02dbbd15d 100644 --- a/docs/CROWDIN/zh_CN/index.md +++ b/docs/CROWDIN/zh_CN/index.md @@ -83,21 +83,22 @@ AAPS简介 <./Getting-Started/Introduction.md> ``` ```{toctree} -:caption: 3) 设置 AAPS +:caption: 3) Setting up AAPS -设置报告服务器 (Setting up the reporting server) <./SettingUpAaps/SettingUpTheReportingServer.md> +Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Nightscout <./SettingUpAaps/Nightscout.md> - Tidepool <./SettingUpAaps/Tidepool.md> -构建 AAPS (Building AAPS) <./SettingUpAaps/BuildingAaps.md> -- 浏览器构建<./SettingUpAaps/BrowserBuild.md> -- 电脑构建 <./SettingUpAaps/ComputerBuild.md> -传输并安装 AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> -设置向导 <./SettingUpAaps/SetupWizard.md> -你的 AAPS 配置文件 <./SettingUpAaps/YourAapsProfile.md> -更改 AAPS 配置 <./SettingUpAaps/ChangeAapsConfiguration.md> -- 配置生成器 <./SettingUpAaps/ConfigBuilder.md> -- 偏好设置 <./SettingUpAaps/Preferences.md> -完成任务阶段 <./SettingUpAaps/CompletingTheObjectives.md> +Building AAPS <./SettingUpAaps/BuildingAaps.md> +- Browser Build <./SettingUpAaps/BrowserBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> +Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> +Setup Wizard <./SettingUpAaps/SetupWizard.md> +Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> +Change AAPS configuration <./SettingUpAaps/ChangeAapsConfiguration.md> +- Config Builder <./SettingUpAaps/ConfigBuilder.md> +- Preferences <./SettingUpAaps/Preferences.md> +Completing the objectives <./SettingUpAaps/CompletingTheObjectives.md> ``` ```{toctree} @@ -140,15 +141,15 @@ Android Auto <./RemoteFeatures/AndroidAuto.md> ``` ```{toctree} -:caption: 7) AAPS 的维护 - -导出/导入设置 <./Maintenance/ExportImportSettings.md> -查看你的数据 <./Maintenance/Reviewing.md> -AAPS 发行说明 <./Maintenance/ReleaseNotes.md> -文档更新 <./Maintenance/DocumentationUpdate.md> -更新至 AAPS 新版本 <./Maintenance/UpdateToNewVersion.md> -- 浏览器更新 <./Maintenance/UpdateBrowserBuild.md> -- 电脑更新 <./Maintenance/UpdateComputerBuild.md> +:caption: 7) Maintenance of AAPS + +Export/Import Settings <./Maintenance/ExportImportSettings.md> +Reviewing your data <./Maintenance/Reviewing.md> +AAPS Release Notes <./Maintenance/ReleaseNotes.md> +Documentation updates <./Maintenance/DocumentationUpdate.md> +Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> +- Browser Update <./Maintenance/UpdateBrowserBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ``` diff --git a/docs/CROWDIN/zh_TW/Maintenance/DocumentationUpdate.md b/docs/CROWDIN/zh_TW/Maintenance/DocumentationUpdate.md index a96e57e46dcd..2216cc34f5f9 100644 --- a/docs/CROWDIN/zh_TW/Maintenance/DocumentationUpdate.md +++ b/docs/CROWDIN/zh_TW/Maintenance/DocumentationUpdate.md @@ -1,5 +1,10 @@ # 文件更新與變更 +## March 2026 + +- [Add CLI Build option](../SettingUpAaps/CLIBuild.md) @je-l +- Rename *Computer Build* to *Android Studio Build*. Preserve file names for URLs. + ## 2025年1月 - [3.4](#version3400) 版發佈與文件更新彙總(嚮導、電腦建置版本、組態建置工具) diff --git a/docs/CROWDIN/zh_TW/Maintenance/UpdateComputerBuild.md b/docs/CROWDIN/zh_TW/Maintenance/UpdateComputerBuild.md index 04cecde9d0db..f8d3f844d24e 100644 --- a/docs/CROWDIN/zh_TW/Maintenance/UpdateComputerBuild.md +++ b/docs/CROWDIN/zh_TW/Maintenance/UpdateComputerBuild.md @@ -1,4 +1,4 @@ -# 透過電腦進行更新 +# Update with Android Studio ## 自行建置,而不是下載 @@ -8,7 +8,7 @@ 如果你想在新電腦上建立 **AAPS**:請將你的備份金鑰存檔複製到新電腦上。 然後按照 [初始建置 **AAPS** 程序](../SettingUpAaps/BuildingAaps.md) 的步驟,而不是這個指導。 唯一的不同之處在於,你可以選擇你在新電腦上複製的金鑰存檔,而不必建立新的金鑰存檔。 ``` -## 使用電腦更新 AAPS 的總覽 +## Overview for updating to a new version of AAPS with Android Studio ```{contents} Steps for updating to a new version of AAPS :depth: 1 diff --git a/docs/CROWDIN/zh_TW/Maintenance/UpdateToNewVersion.md b/docs/CROWDIN/zh_TW/Maintenance/UpdateToNewVersion.md index 2ceba177a9a3..40127562ca40 100644 --- a/docs/CROWDIN/zh_TW/Maintenance/UpdateToNewVersion.md +++ b/docs/CROWDIN/zh_TW/Maintenance/UpdateToNewVersion.md @@ -16,10 +16,14 @@ 如果你已使用瀏覽器版本方法建置了 AAPS 應用程式,請遵循 [這些指示](./UpdateBrowserBuild.md)。 -## 使用電腦更新 AAPS +## Update AAPS with Android Studio 請遵循 [這些指示。](./UpdateComputerBuild.md) +## Update AAPS with the command-line + +Use the [same instructions](../SettingUpAaps/CLIBuild.md) as when building AAPS previously, but pull new changes with git. + (Update-to-new-version-check-aaps-version-on-phone)= ### 檢查手機上的 AAPS 版本 diff --git a/docs/CROWDIN/zh_TW/SettingUpAaps/BuildingAaps.md b/docs/CROWDIN/zh_TW/SettingUpAaps/BuildingAaps.md index 93fbde1cccaf..e1aafdb1e51f 100644 --- a/docs/CROWDIN/zh_TW/SettingUpAaps/BuildingAaps.md +++ b/docs/CROWDIN/zh_TW/SettingUpAaps/BuildingAaps.md @@ -8,9 +8,9 @@ --- -提供兩種方法來建立 AAPS 應用程式: +Three methods are available to build the AAPS app: -### 使用瀏覽器建立 +### Build with a browser (recommended) 您可以使用 GitHub actions 在智慧型手機上建立應用程式,並將其儲存在 Google 雲端硬碟中。 @@ -18,9 +18,16 @@ ---- -### 使用電腦建立 +### Build with Android Studio -您可以使用 Android Studio 在電腦上建立應用程式。 +You can build the app with your computer using Android Studio. This used to be the only build option, nowadays Android Studio is mostly used by developers who consider making code changes. **[請按照這些指示進行操作。](./ComputerBuild.md)** +---- + +### Build using the command-line + +This option is intended for those who prefer to build AAPS in local command-line, without installing Android Studio. + +**[請按照這些指示進行操作。](./CLIBuild.md)** diff --git a/docs/CROWDIN/zh_TW/SettingUpAaps/CLIBuild.md b/docs/CROWDIN/zh_TW/SettingUpAaps/CLIBuild.md new file mode 100644 index 000000000000..bc0c361ef399 --- /dev/null +++ b/docs/CROWDIN/zh_TW/SettingUpAaps/CLIBuild.md @@ -0,0 +1,54 @@ +# Build instructions for the command-line + +```{admonition} For users familiar with the command-line and git +:class: information + +The simplest option to build AAPS is the [Browser build](./BrowserBuild.md) alternative. +``` + +Tested with Fedora and Debian Linux, other systems should work with minimal adjustments. + +## 需求 + +Consult the minimum required Java version from [this table](#Building-APK-recommended-specification-of-computer-for-building-apk-file). Install the appropriate OpenJDK package using the system package manager. For example in Debian, the packages are named like `openjdk-21-jdk`. It should include `javac` and `keytool` binaries. + +Download the *Android Command line tools* package from the [Android Studio page](https://developer.android.com/studio#command-line-tools-only). Android Studio itself is not required. More information about installing this package is found in [sdkmanager docs](https://developer.android.com/tools/sdkmanager). After the package is installed, you should manually set two [environment variables](https://developer.android.com/tools/variables): `ANDROID_HOME` and `PATH`. Finally, run `sdkmanager --licenses` to finish the installation. + +## Building AAPS with Gradle wrapper + +### 1. Generate a Java keystore file for signing AAPS + +If you already have a keystore file for signing AAPS, reuse that. + +```sh +keytool -genkeypair -v \ + -keystore aaps-keystore.jks \ + -alias aaps-key \ + -keyalg RSA \ + -keysize 4096 \ + -validity 20000 +``` + +You will need the keystore file and passphrase every time you update AAPS. + +### 2. Compile the AAPS APK file + +Clone the [git repo](https://github.com/nightscout/AndroidAPS) if not already cloned. AAPS uses master branch for the latest stable version, ensure you are on the branch/tag you want to build. + +Run `./gradlew :app:assembleFullRelease` in the repo. It automatically downloads Gradle, dependencies, and then compiles the code. When the build succeeds, you should have an unsigned APK at `app/build/outputs/apk/full/release/app-full-release-unsigned.apk`. It should have also installed an `apksigner` binary to `$ANDROID_HOME`. Update your `PATH` again. + +### 3. Create a signed APK file from the unsigned one + + + +Change to your home directory and create a signed APK file: + +```sh +apksigner sign \ + --ks path/to/aaps-keystore.jks \ + --ks-key-alias aaps-key \ + --out app-full-release-signed.apk \ + ./AndroidAPS/app/build/outputs/apk/full/release/app-full-release-unsigned.apk +``` + +Now you have `app-full-release-signed.apk` ready for installation or upgrade. diff --git a/docs/CROWDIN/zh_TW/SettingUpAaps/ComputerBuild.md b/docs/CROWDIN/zh_TW/SettingUpAaps/ComputerBuild.md index 22abb9439e93..37cd3a434b4b 100644 --- a/docs/CROWDIN/zh_TW/SettingUpAaps/ComputerBuild.md +++ b/docs/CROWDIN/zh_TW/SettingUpAaps/ComputerBuild.md @@ -1,4 +1,6 @@ -# 電腦建立 + + +# Android Studio Build 這是傳統的方法來建立您的 AAPS 應用程式。 diff --git a/docs/CROWDIN/zh_TW/index.md b/docs/CROWDIN/zh_TW/index.md index 8232fa988107..79569eb4d23c 100644 --- a/docs/CROWDIN/zh_TW/index.md +++ b/docs/CROWDIN/zh_TW/index.md @@ -84,21 +84,22 @@ AAPS 簡介 <./Getting-Started/Introduction.md> ``` ```{toctree} -:caption: 3) 設定 AAPS +:caption: 3) Setting up AAPS -設定報告伺服器 <./SettingUpAaps/SettingUpTheReportingServer.md> +Setting up the reporting server <./SettingUpAaps/SettingUpTheReportingServer.md> - Nightscout <./SettingUpAaps/Nightscout.md> - Tidepool <./SettingUpAaps/Tidepool.md> -建置 AAPS <./SettingUpAaps/BuildingAaps.md> -- 瀏覽器建置 <./SettingUpAaps/BrowserBuild.md> -- 電腦建置 <./SettingUpAaps/ComputerBuild.md> -傳輸和安裝 AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> -嚮導 <./SettingUpAaps/SetupWizard.md> -您的 AAPS 設定檔 <./SettingUpAaps/YourAapsProfile.md> -變更 AAPS 配置 <./SettingUpAaps/ChangeAapsConfiguration.md> -- 配置建構器 <./SettingUpAaps/ConfigBuilder.md> -- 偏好設定 <./SettingUpAaps/Preferences.md> -完成目標 <./SettingUpAaps/CompletingTheObjectives.md> +Building AAPS <./SettingUpAaps/BuildingAaps.md> +- Browser Build <./SettingUpAaps/BrowserBuild.md> +- Android Studio Build <./SettingUpAaps/ComputerBuild.md> +- CLI Build <./SettingUpAaps/CLIBuild.md> +Transferring and Installing AAPS <./SettingUpAaps/TransferringAndInstallingAaps.md> +Setup Wizard <./SettingUpAaps/SetupWizard.md> +Your AAPS Profile <./SettingUpAaps/YourAapsProfile.md> +Change AAPS configuration <./SettingUpAaps/ChangeAapsConfiguration.md> +- Config Builder <./SettingUpAaps/ConfigBuilder.md> +- Preferences <./SettingUpAaps/Preferences.md> +Completing the objectives <./SettingUpAaps/CompletingTheObjectives.md> ``` ```{toctree} @@ -141,15 +142,15 @@ AAPS for Wear OS <./WearOS/BuildingAapsWearOS.md> ``` ```{toctree} -:caption: 7) AAPS 維護 - -匯出/匯入設定 <./Maintenance/ExportImportSettings.md> -檢查您的資料 <./Maintenance/Reviewing.md> -AAPS 版本更新說明 <./Maintenance/ReleaseNotes.md> -文檔更新 <./Maintenance/DocumentationUpdate.md> -更新到新的 AAPS 版本 <./Maintenance/UpdateToNewVersion.md> -- 瀏覽器更新 <./Maintenance/UpdateBrowserBuild.md> -- 電腦更新 <./Maintenance/UpdateComputerBuild.md> +:caption: 7) Maintenance of AAPS + +Export/Import Settings <./Maintenance/ExportImportSettings.md> +Reviewing your data <./Maintenance/Reviewing.md> +AAPS Release Notes <./Maintenance/ReleaseNotes.md> +Documentation updates <./Maintenance/DocumentationUpdate.md> +Updating to a new version of AAPS <./Maintenance/UpdateToNewVersion.md> +- Browser Update <./Maintenance/UpdateBrowserBuild.md> +- Android Studio Update <./Maintenance/UpdateComputerBuild.md> ```