Skip to content

Commit 4778bd5

Browse files
gardarhaoict
authored andcommitted
docs: document supported platforms and build instructions
Signed-off-by: gardar <gardar@users.noreply.github.com>
1 parent 5f6bc4d commit 4778bd5

1 file changed

Lines changed: 62 additions & 13 deletions

File tree

README.md

Lines changed: 62 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,7 @@ Simple Terminal Emulator for embedded Linux handhelds, migrated from SDL1.2 to S
77
<img src="images/st-img3.jpeg?raw=true" alt="Image3" width="250"/>
88
<img src="images/st-img1-trimuisp.jpg?raw=true" alt="Image1-TrimuiSP" width="250"/>
99

10-
# Build
11-
12-
For generic linux:
13-
14-
```bash
15-
sudo apt install build-essential libsdl2-dev libsdl2-ttf-dev
16-
make
17-
```
18-
19-
# Run
10+
## Run
2011

2112
```bash
2213
./simple-terminal
@@ -51,9 +42,40 @@ Simple Terminal supports scrollback history to review previous output:
5142
- **Scroll indicator**: When scrolled, a `[offset]^` indicator appears in the top-right corner
5243
- **Auto-reset**: Any key press (except scroll keys) returns to the bottom of the buffer
5344

54-
# Build with buildroot toolchain
5545

56-
you can build everything for the target device with buildroot:
46+
## Platforms
47+
48+
SimpleTerminal includes built-in input mappings for several embedded handheld devices.
49+
50+
When building for a handheld device, specify the target platform using the PLATFORM variable:
51+
52+
```bash
53+
make PLATFORM=<platform>
54+
```
55+
56+
Currently supported platforms include:
57+
- `rgb30`
58+
- `h700`
59+
- `r36s`
60+
- `pi` (Raspberry Pi / generic controller)
61+
62+
If no platform is specified, SimpleTerminal builds with a generic Linux keyboard mapping.
63+
64+
Note: The `PLATFORM` option currently only affects controller and keyboard input mappings. Other devices may work correctly if their controller layout matches one of the existing platforms.
65+
66+
67+
## Build
68+
69+
### Generic linux
70+
71+
```bash
72+
sudo apt install build-essential libsdl2-dev libsdl2-ttf-dev
73+
make
74+
```
75+
76+
### Build with buildroot toolchain
77+
78+
You can build everything for the target device with buildroot:
5779
https://github.com/haoict/TiniLinux/blob/master/README.md#build
5880

5981
or build the toolchain only and build simple-terminal separately
@@ -71,7 +93,34 @@ export CROSS_COMPILE=/home/haoict/TiniLinux/output.toolchain_x86_64_aarch64/host
7193
make
7294
```
7395

74-
# To edit embedded bitmap font
96+
### Build using Podman
97+
98+
You can also build SimpleTerminal using Podman.
99+
100+
```bash
101+
podman run --rm -it \
102+
-v "$PWD:/work:Z" -w /work \
103+
docker.io/debian:trixie-slim \
104+
bash -lc '
105+
set -euo pipefail
106+
107+
dpkg --add-architecture arm64
108+
apt update
109+
apt install -y --no-install-recommends \
110+
make pkg-config \
111+
gcc-aarch64-linux-gnu libc6-dev-arm64-cross \
112+
libsdl2-dev:arm64 libsdl2-ttf-dev:arm64
113+
114+
export CC=aarch64-linux-gnu-gcc
115+
export PKG_CONFIG_LIBDIR=/usr/lib/aarch64-linux-gnu/pkgconfig:/usr/share/pkgconfig
116+
export PKG_CONFIG_SYSROOT_DIR=/
117+
118+
make clean || true
119+
make PLATFORM=r36s CC="$CC"
120+
'
121+
```
122+
123+
## To edit embedded bitmap font
75124

76125
https://simple-terminal-psi.vercel.app
77126

0 commit comments

Comments
 (0)