sjg/trx-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs](trx-rs): remove appkit frontend references

Browse Source 
Remove AppKit frontend mentions from documentation:
- Update AGENTS.md project structure
- Remove AppKit from capabilities table in OVERVIEW.md
- Remove AppKit from frontends table in OVERVIEW.md
- Remove AppKit from Frontends section in README.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Stanislaw Grams <stanislawgrams@gmail.com>
This commit is contained in:
Stan Grams
2026-02-12 20:06:03 +01:00
parent 55fde37924
commit cf67574571
3 changed files with 1 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+1 -1
View File
@@ -4,7 +4,7 @@
- Workspace root contains `Cargo.toml`, `README.md`, and contributor docs. - Workspace root contains `Cargo.toml`, `README.md`, and contributor docs.
- Core crates live under `src/`: `src/trx-core`, `src/trx-server`, and `src/trx-client`. - Core crates live under `src/`: `src/trx-core`, `src/trx-server`, and `src/trx-client`.
- Server backends are under `src/trx-server/trx-backend` (example: `trx-backend-ft817`). - Server backends are under `src/trx-server/trx-backend` (example: `trx-backend-ft817`).
- Client frontends are under `src/trx-client/trx-frontend` (HTTP, JSON, AppKit, rigctl). - Client frontends are under `src/trx-client/trx-frontend` (HTTP, JSON, rigctl).
- Examples live in `examples/` and static assets in `assets/`. - Examples live in `examples/` and static assets in `assets/`.
- Reference configs are `trx-server.toml.example` and `trx-client.toml.example`. - Reference configs are `trx-server.toml.example` and `trx-client.toml.example`.
OVERVIEW.md
-2
View File
@@ -19,7 +19,6 @@
| Backend/frontend registry | Implemented | | Backend/frontend registry | Implemented |
| TCP CAT transport | Partial (config wiring only) | | TCP CAT transport | Partial (config wiring only) |
| JSON TCP control (line-delimited) | Implemented (configurable frontend) | | JSON TCP control (line-delimited) | Implemented (configurable frontend) |
| AppKit GUI frontend | Implemented (macOS only, optional) |
| Plugin registry loading | Implemented (shared libraries) | | Plugin registry loading | Implemented (shared libraries) |
| Configuration file (TOML) | Implemented | | Configuration file (TOML) | Implemented |
| Rig state machine | Implemented | | Rig state machine | Implemented |
@@ -81,7 +80,6 @@
| `trx-frontend` | Frontend trait (`FrontendSpawner`) | | `trx-frontend` | Frontend trait (`FrontendSpawner`) |
| `trx-frontend-http` | Web UI with REST API and SSE | | `trx-frontend-http` | Web UI with REST API and SSE |
| `trx-frontend-http-json` | JSON-over-TCP control frontend | | `trx-frontend-http-json` | JSON-over-TCP control frontend |
| `trx-frontend-appkit` | AppKit GUI frontend (macOS only, optional) |
| `trx-frontend-rigctl` | Hamlib rigctl-compatible TCP interface | | `trx-frontend-rigctl` | Hamlib rigctl-compatible TCP interface |
| `trx-server` | Server binary — connects to rig backend, exposes JSON TCP control | | `trx-server` | Server binary — connects to rig backend, exposes JSON TCP control |
| `trx-client` | Client binary — connects to server, runs frontends (HTTP, rigctl) | | `trx-client` | Client binary — connects to server, runs frontends (HTTP, rigctl) |
README.md
-1
View File
@@ -17,7 +17,6 @@ The rig task is now driven by the controller components (state machine, handlers
- HTTP status/control frontend (`trx-frontend-http`) - HTTP status/control frontend (`trx-frontend-http`)
- JSON TCP control frontend (`trx-frontend-http-json`) - JSON TCP control frontend (`trx-frontend-http-json`)
- AppKit GUI frontend (`trx-frontend-appkit`, macOS only, optional via `appkit-frontend` feature)
- rigctl-compatible TCP frontend (`trx-frontend-rigctl`, listens on 127.0.0.1:4532) - rigctl-compatible TCP frontend (`trx-frontend-rigctl`, listens on 127.0.0.1:4532)
## Audio streaming ## Audio streaming