summaryrefslogtreecommitdiff
path: root/docs/PATHS.md
blob: c0ba5d3c112b1dbfb0d7401a15793d42e7a16103 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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) |
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com