summaryrefslogtreecommitdiff
path: root/stacks/terminal/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'stacks/terminal/README.md')
-rw-r--r--stacks/terminal/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/stacks/terminal/README.md b/stacks/terminal/README.md
new file mode 100644
index 0000000..6b0dea1
--- /dev/null
+++ b/stacks/terminal/README.md
@@ -0,0 +1,31 @@
+# MAX25 Terminal (`max25-terminal` / `max25-client`)
+
+Official text-only operator client for `max25d`. Cross-platform via M25/1 (TCP or Unix).
+
+| Doc | Audience |
+|-----|----------|
+| [docs/MAX25-CLIENT.md](../../docs/MAX25-CLIENT.md) | Developer — M25/1 binding |
+| [docs/MAX25-TERMINAL.md](../../docs/MAX25-TERMINAL.md) | Operator — F10 menu, usage |
+
+## Build & test
+
+```bash
+./scripts/build.sh
+bash stacks/terminal/test-terminal.sh
+```
+
+Requires C11 compiler and ncurses (`libncurses-dev` on Linux).
+
+## Run (canonical)
+
+Prefer install/PATH or `build*/bin/max25-terminal`. Tree binary may live at `./max25-terminal` after copy (gitignored).
+
+```bash
+max25-terminal -U /run/max25/modem.sock
+# with [devices] default set in max25d.ini — no -d needed
+# then: CONNECT (F10→6) → SEND …
+```
+
+Optional: `-d <id>` / `SET DEVICE` / F10→7 to override the default device.
+
+Daemon: [stacks/daemon/README.md](../daemon/README.md) — **not** under this directory.
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com