diff options
Diffstat (limited to 'plugins/devices/soft-crdop/README.md')
| -rw-r--r-- | plugins/devices/soft-crdop/README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/plugins/devices/soft-crdop/README.md b/plugins/devices/soft-crdop/README.md new file mode 100644 index 0000000..fe44f9d --- /dev/null +++ b/plugins/devices/soft-crdop/README.md @@ -0,0 +1,26 @@ +# Device: soft-crdop (MAX25-SoftModem / CRDOP — MAX25-SoftModem) + +**CRDOP** = stack acronym for **MAX25-SoftModem** (device id `soft-crdop`). + +**Status:** `active` — MAX25-Stack **standard subproject** (`stacks/crdop/`). + +**Canonical rule:** [docs/CRDOP.md](../../../docs/CRDOP.md) · **License:** GNU GPL v3 + +## Summary + +| Topic | Policy | +|-------|--------| +| Type | Sound-card software modem subproject | +| Compatibility | **AX.25 / KISS / TNC / modem** (software-modem domain) | +| Mission | **Hardware solutions** (primary) + pure **software** on computers | +| Audio | Kernel ALSA + MAX25 sound-proxy — **no PulseAudio** | +| Build | Default ON — `-DMAX25_BUILD_CRDOP=OFF` to skip | + +## Quick start + +```bash +./scripts/build.sh +./scripts/max25-ctl start --hardware soft-modems --device soft-crdop +``` + +See [docs/CRDOP.md](../../../docs/CRDOP.md) for full project rules. |