Skip to content

Commit 4e34eb9

Browse files
committed
refactor(docs): move termux info install -> termux
1 parent f06a7cc commit 4e34eb9

File tree

3 files changed

+48
-29
lines changed

3 files changed

+48
-29
lines changed

ci/dev/fmt.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ main() {
3030
doctoc --title '# Maintaining' docs/MAINTAINING.md >/dev/null
3131
doctoc --title '# Contributor Covenant Code of Conduct' docs/CODE_OF_CONDUCT.md >/dev/null
3232
doctoc --title '# iPad' docs/ipad.md >/dev/null
33-
doctoc --title '# Termux' docs/ipad.md >/dev/null
33+
doctoc --title '# Termux' docs/termux.md >/dev/null
3434

3535
if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
3636
echo "Files need generation or are formatted incorrectly:"

docs/install.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
- [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse)
1111
- [Arch Linux](#arch-linux)
1212
- [Termux](#termux)
13-
- [Known Search Issue](#known-search-issue)
1413
- [yarn, npm](#yarn-npm)
1514
- [macOS](#macos)
1615
- [Standalone Releases](#standalone-releases)
@@ -131,32 +130,7 @@ sudo systemctl enable --now code-server@$USER
131130

132131
## Termux
133132

134-
Termux is an Android terminal application and Linux environment, which can also run code-server from your phone.
135-
136-
1. Install Termux from the [Google Play Store](https://play.google.com/store/apps/details?id=com.termux&hl=en_US&gl=US)
137-
2. Make sure it's up-to-date by running `apt update && apt upgrade`
138-
3. Install required packages: `apt install build-essential python git nodejs yarn`
139-
4. Install code-server: `yarn global add code-server`
140-
5. Run code-server: `code-server` and navigate to localhost:8080 in your browser
141-
142-
To upgrade run: `yarn global upgrade code-server --latest`
143-
144-
### Known Search Issue
145-
146-
There is a known issue with search not working on Android because it's missing `bin/rg`. To fix:
147-
148-
1. Install `ripgrep` with `pkg`
149-
```sh
150-
pkg install ripgrep
151-
```
152-
2. Make a soft link using `ln -s`
153-
154-
```sh
155-
# run this command inside the code-server directory
156-
ln -s $PREFIX/bin/rg ./lib/vscode/node_modules/vscode-ripgrep/bin/rg
157-
```
158-
159-
For more context, see [comment](https://github.com/cdr/code-server/issues/1730#issuecomment-721515979).
133+
Please see "Installation" in the [Termux docs](./termux.md#installation)
160134

161135
## yarn, npm
162136

docs/termux.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,46 @@
1-
# Termux
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
# Termux
4+
5+
- [Termux](#termux)
6+
- [Installation](#installation)
7+
- [Upgrading](#upgrading)
8+
- [Known Issues](#known-issues)
9+
- [Search issue](#search-issue)
10+
11+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
12+
13+
# Termux
14+
15+
Termux is an Android terminal application and Linux environment, which can also run code-server from your phone.
16+
17+
## Installation
18+
19+
1. Install Termux from the [Google Play Store](https://play.google.com/store/apps/details?id=com.termux&hl=en_US&gl=US)
20+
2. Make sure it's up-to-date by running `apt update && apt upgrade`
21+
3. Install required packages: `apt install build-essential python git nodejs yarn`
22+
4. Install code-server: `yarn global add code-server`
23+
5. Run code-server: `code-server` and navigate to localhost:8080 in your browser
24+
25+
## Upgrading
26+
27+
To upgrade run: `yarn global upgrade code-server --latest`
28+
29+
## Known Issues
30+
31+
### Search issue
32+
33+
There is a known issue with search not working on Android because it's missing `bin/rg`. To fix:
34+
35+
1. Install `ripgrep` with `pkg`
36+
```sh
37+
pkg install ripgrep
38+
```
39+
2. Make a soft link using `ln -s`
40+
41+
```sh
42+
# run this command inside the code-server directory
43+
ln -s $PREFIX/bin/rg ./lib/vscode/node_modules/vscode-ripgrep/bin/rg
44+
```
45+
46+
For more context, see [comment](https://github.com/cdr/code-server/issues/1730#issuecomment-721515979).

0 commit comments

Comments
 (0)