diff options
| author | info@mode42.com <info@mode42.com> | 2026-08-07 18:25:13 +0000 |
|---|---|---|
| committer | info@mode42.com <info@mode42.com> | 2026-08-07 18:25:13 +0000 |
| commit | 04d965d67a7264a1c7c211494aebda1953df7603 (patch) | |
| tree | 0ebd700a6e219f84a26a656f4bee8778bc75da7b /docs/PATHS.md | |
Initial push
Diffstat (limited to 'docs/PATHS.md')
| -rw-r--r-- | docs/PATHS.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/PATHS.md b/docs/PATHS.md new file mode 100644 index 0000000..c0ba5d3 --- /dev/null +++ b/docs/PATHS.md @@ -0,0 +1,46 @@ +# Repository paths · MAX25-Stack + +Canonical directory map for contributors and operators. + +## Top-level matrix + +| Path | Role | +|------|------| +| `stacks/daemon/` | max25d supervisor (`max25d` / `max25d.py`) — **not** the terminal | +| `stacks/terminal/` | operator client (`max25-terminal`) | +| `stacks/tncs/` | TNC boot-wait, recovery | +| `stacks/max25-bcpr/` | BayCom/based SER12 (max25-bcpr) · `max25-bcprd` / `max25-bcpr-ctl` | +| `stacks/crdop/` | MAX25-SoftModem | +| `plugins/` | hardware/device registry | +| `share/max25/` | max25d INI examples | +| `share/hybbx/` | HyBBX attach fragments | +| `docs/` | shipped documentation | +| `scripts/` | build, test, install · `tx-rx-test.sh` | + +## Operator binaries (do not invent paths) + +| Binary | Canonical | +|--------|-----------| +| max25d | `stacks/daemon/max25d` · install `/usr/local/bin/max25d` | +| max25-terminal | **`scripts/run-max25-terminal.sh`** · `/usr/local/bin/max25-terminal` · `build*/bin/max25-terminal` | +| max25-bcpr-ctl | `stacks/max25-bcpr/tools/max25-bcpr-ctl` · install `/usr/local/sbin/max25-bcpr-ctl` | +| max25-bcprd | `build*/bin/max25-bcprd` · install `/usr/local/bin/max25-bcprd` | +| max25d (start) | **`scripts/run-max25d.sh`** · `stacks/daemon/max25d` | + +Wrong: `stacks/daemon/max25-terminal` (does not exist). +Wrong: relying on leftover ELF `stacks/terminal/max25-terminal` (gitignored; often stale, missing `-d`). + +## Config matrix + +| Live config | Path | +|-------------|------| +| Operator secrets | `./local/` (gitignored) | +| System INI example | `share/max25/max25d.ini.example` | +| HyBBX fragments | `share/hybbx/*-host.ini.example` | + +## Related + +| Goal | Doc | +|------|-----| +| Development | [DEVELOPMENT.md](DEVELOPMENT.md) | +| Doc index | [README.md](README.md) | |