summaryrefslogtreecommitdiff
path: root/docs/README.md
blob: 6f5b79fa6cc3fd4acace0e1a58d9729c190ae254 (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
# Documentation index · MAX25-Stack 1.8.0

Compact doc map for MAX25 — start at MASTER-GUIDE for linear operator flow.

## By role matrix

| Role | Document |
|------|----------|
| Master operator guide | [MASTER-GUIDE.md](MASTER-GUIDE.md) |
| TNC / modem bring-up | [DEV/TNC-MODEM-DEV.md](DEV/TNC-MODEM-DEV.md) |
| Host setup | [LINUX-HOST-SETUP.md](LINUX-HOST-SETUP.md) |
| Device workflow | [PLUGINS-DEVICE-MODEL.md](PLUGINS-DEVICE-MODEL.md) |
| Terminal operator | [MAX25-TERMINAL.md](MAX25-TERMINAL.md) |
| Client / M25/1 | [MAX25-CLIENT.md](MAX25-CLIENT.md) |
| HyBBX integrator | [HYBBX.md](HYBBX.md) |
| BayCom / PC-COM | [BAYCOM.md](BAYCOM.md) |
| BayCom freeze warning (RX/TX) | [BAYCOM-FREEZES.md](BAYCOM-FREEZES.md) |
| TX/RX release test (TNC + BayCom/based) | [TX-RX-TEST.md](TX-RX-TEST.md) |
| Operator runbook | [MAX25-OPERATOR-RUNBOOK.md](MAX25-OPERATOR-RUNBOOK.md) |
| Contributor | [DEVELOPMENT.md](DEVELOPMENT.md) |

## Technical reference matrix

| Topic | Document |
|-------|----------|
| Architecture | [ARCHITECTURE.md](ARCHITECTURE.md) |
| Packet radio / AX.25 | [PACKET-RADIO.md](PACKET-RADIO.md) |
| CRDOP / SoftModem | [CRDOP.md](CRDOP.md) |
| Platforms | [PLATFORMS.md](PLATFORMS.md) |
| FreeBSD port | [FREEBSD-AX25.md](FREEBSD-AX25.md) |
| Modular TCP/IP | [MODULAR-TCPIP-SERVER.md](MODULAR-TCPIP-SERVER.md) |
| v1 scope | [V1.0.0-SCOPE.md](V1.0.0-SCOPE.md) |
| v2 goals | [V2.0.0-SCOPE.md](V2.0.0-SCOPE.md) |

## Related

| Goal | Doc |
|------|-----|
| Root README | [../README.md](../README.md) |
| Release gates | [../RELEASE-READINESS.md](../RELEASE-READINESS.md) |
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com