Skip to content

Commit 0b7d926

Browse files
committed
docs: move Termux setup notes into dedicated docs page
1 parent 1d8ec69 commit 0b7d926

2 files changed

Lines changed: 45 additions & 6 deletions

File tree

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -448,14 +448,11 @@ Use the `--doctor` flag to verify the environment, network connectivity, and API
448448
explainthisrepo --doctor
449449
```
450450

451-
## Termux (Android) install notes
451+
## Termux (Android)
452452

453-
Termux has some environment limitations that can make `pip install explainthisrepo` fail to create the `explainthisrepo` command in `$PREFIX/bin`.
453+
ExplainThisRepo supports Termux on Android.
454454

455-
However, it's recommended you install using:
456-
457-
```bash
458-
pip
455+
For installation notes, PATH setup, Gemini support, and mobile-specific recommendations: see [docs/TERMUX.md](https://github.com/calchiwo/ExplainThisRepo/blob/main/docs/TERMUX.md)
459456

460457
## Philosophy
461458

docs/TERMUX.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Termux (Android) setup notes
2+
3+
ExplainThisRepo supports running inside the Termux environments on Android devices
4+
5+
Termux has some environment limitations that can make `pip install explainthisrepo` fail to create the `explainthisrepo` command in `$PREFIX/bin`.
6+
7+
However, it's recommended you install using:
8+
9+
```bash
10+
pip install --user -U explainthisrepo
11+
```
12+
13+
Make sure your user bin directory is on your PATH:
14+
15+
```bash
16+
export PATH="$HOME/.local/bin:$PATH"
17+
```
18+
19+
> Tip: Add the PATH export to your `~/.bashrc` or `~/.zshrc` so it persists.
20+
21+
### Alternative (No PATH changes)
22+
23+
If you do not want to modify PATH, you can run ExplainThisRepo as a module:
24+
25+
```bash
26+
python -m explain_this_repo owner/repo
27+
```
28+
29+
### Gemini support on Termux
30+
31+
Installing Gemini support may require building Rust-based dependencies on Android, which can take time on first install:
32+
33+
```bash
34+
pip install --user -U "explainthisrepo[gemini]"
35+
```
36+
37+
For mobile environments like Termux where compiling Python dependencies can be slow,
38+
you can also run ExplainThisRepo using the Node.js version:
39+
40+
```bash
41+
npx explainthisrepo owner/repo
42+
```

0 commit comments

Comments
 (0)