diff options
Diffstat (limited to 'docs/DEVELOPMENT.md')
| -rw-r--r-- | docs/DEVELOPMENT.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md new file mode 100644 index 0000000..c7a8182 --- /dev/null +++ b/docs/DEVELOPMENT.md @@ -0,0 +1,37 @@ +# Development ยท HyBBX 2.8.0 + +Contributor build, test, and code layout reference. + +## Workflow matrix + +| Step | Command | +|------|---------| +| Debug build | `cmake -B build -DCMAKE_BUILD_TYPE=Debug && cmake --build build` | +| Tests | `-DHYBBX_BUILD_TESTS=ON && ctest --test-dir build` | +| Clients only | `-DHYBBX_CLIENTS_ONLY=ON` | +| Format / lint | project scripts in `scripts/` | + +## Layout matrix + +| Path | Content | +|------|---------| +| `src/` | Daemon core | +| `plugins/` | Transport plugins | +| `include/hybbx/` | Public headers | +| `share/` | INI templates, YAML registries | +| `tests/` | Unit tests (opt-in build) | + +## v2.8.0 dev notes matrix + +| Topic | Rule | +|-------|------| +| MAX25 boundary | No BayCom/PC-COM in `packet_radio` | +| Local TNC tests | Mock max25d `:7325` recommended | +| Live secrets | `./local/` only | + +## Related + +| Goal | Doc | +|------|-----| +| Build | [BUILD.md](BUILD.md) | +| Contributing | [../CONTRIBUTING.md](../CONTRIBUTING.md) | |