Skip to content

Commit 049574b

Browse files
committed
Drop pre-migration setup from the Android README
Quick Start and "Initial Setup" still described the standalone kolibri-installer-android repo -- clone it, `uv venv`, and `make get-tar` a pinned v0.17.0 release URL -- contradicting the "Monorepo & Android Studio" section directly above them. Delete Initial Setup, point Quick Start at `uv sync --group dev --all-packages` and `make stage-workspace-tar`, and reword the monorepo section as direct instructions now that the standalone commands it was a delta against are gone. Prerequisites keeps the JDK and Python toolchain facts and gains a pointer to the monorepo section, so it does not dead-end. `make get-tar` stays a valid target -- platform-android-build_apk.yml uses it for the workflow_dispatch tar-url path. This only stops the README recommending it.
1 parent 5d550b2 commit 049574b

1 file changed

Lines changed: 17 additions & 44 deletions

File tree

platforms/android/README.md

Lines changed: 17 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ workspace member. Open **`platforms/android/`** (not the monorepo root) as the
1717
Android Studio project — Android Studio maps the enclosing monorepo as the VCS
1818
root above it, so history and `git blame` still work.
1919

20-
The build consumes the shared workspace rather than a standalone checkout, so in
21-
the monorepo prefer these over the standalone commands shown below:
22-
23-
- **Python / `buildPython`:** resolves to the shared root `.venv`. Create it from
24-
the monorepo root with `uv sync --group dev --all-packages` (not a standalone
25-
`uv venv`).
26-
- **Kolibri tar:** stage the workspace-built tar with `make stage-workspace-tar`
27-
— it builds `kolibri-*.tar.gz` from the monorepo and copies it into `tar/`,
28-
replacing the `make get-tar tar=<URL>` download.
20+
The build consumes the shared workspace rather than a standalone checkout:
21+
22+
- **Python / `buildPython`:** resolves to the shared root `.venv`. Create it with
23+
`uv sync --group dev --all-packages` — uv finds the workspace root from any
24+
member directory, so this works from `platforms/android/` too. The venv lands
25+
at the monorepo root; nothing needs activating, since both the Makefile and
26+
`app/build.gradle` resolve `../../../.venv` directly.
2927
- **Chaquopy runtime:** the embedded runtime (`requirements.txt`) stays
3028
Chaquopy-resolved and out of the workspace lock — install it into the shared
31-
`.venv` with `uv pip install -r requirements.txt` as before.
29+
`.venv` with `uv pip install -r requirements.txt`.
30+
- **Kolibri tar:** `make stage-workspace-tar` builds `kolibri-*.tar.gz` from the
31+
monorepo and copies it into `tar/`.
3232

3333
The nested `AGENTS.md` / `CLAUDE.md` in this directory remain the
3434
Android-specific developer docs.
@@ -39,16 +39,15 @@ Android-specific developer docs.
3939
# 1. Ensure JDK 21 is installed
4040
java -version
4141

42-
# 2. Setup Python environment (recommended)
43-
uv sync --extra build
42+
# 2. Set up the shared workspace Python environment
43+
uv sync --group dev --all-packages
4444
uv pip install -r requirements.txt
45-
source .venv/bin/activate
4645

4746
# 3. Setup Android SDK and emulator
4847
make setup
4948

50-
# 4. Download Kolibri tar file
51-
make get-tar tar=https://github.com/learningequality/kolibri/releases/download/v0.17.0/kolibri-0.17.0.tar.gz
49+
# 4. Build & stage the workspace Kolibri tar
50+
make stage-workspace-tar
5251

5352
# 5. Build!
5453
make kolibri.apk.unsigned
@@ -67,35 +66,8 @@ Output: `dist/kolibri-*.apk`
6766

6867
- **Python 3.10+** - For build scripts and Chaquopy
6968

70-
### Initial Setup
71-
72-
1. **Clone the repository**
73-
```bash
74-
git clone https://github.com/learningequality/kolibri-installer-android.git
75-
cd kolibri-installer-android
76-
```
77-
78-
2. **Set up Python virtual environment**
79-
```bash
80-
uv venv
81-
source .venv/bin/activate
82-
uv pip install ".[build]" -r requirements.txt
83-
```
84-
85-
3. **Set up Android SDK** (automatically downloads SDK, NDK, emulator)
86-
```bash
87-
make setup
88-
```
89-
90-
4. **Get Kolibri tar file**
91-
```bash
92-
make get-tar tar=<URL_TO_KOLIBRI_TAR>
93-
```
94-
95-
5. **Build the APK**
96-
```bash
97-
make kolibri.apk.unsigned
98-
```
69+
For the Python environment and Kolibri tar, see
70+
[Monorepo & Android Studio](#monorepo--android-studio) above.
9971

10072
## Architecture
10173

@@ -189,6 +161,7 @@ make kolibri.apk
189161
```bash
190162
make help # Show all available targets
191163
make setup # Setup SDK, NDK, and emulator
164+
make stage-workspace-tar # Build & stage the workspace Kolibri tar into tar/ (no download)
192165
make kolibri.apk.unsigned # Build debug APK
193166
make kolibri.apk # Build release APK (requires signing keys)
194167
make kolibri.aab # Build release AAB for Play Store

0 commit comments

Comments
 (0)