better readme, finally working everything

This commit is contained in:
Priec
2026-06-10 22:28:59 +02:00
parent 9b6e594d2f
commit 32d593de55
6 changed files with 422 additions and 23 deletions

View File

@@ -1,20 +1,38 @@
# Hey
# komp_ac
This is only work in progress, until release 1.0.0 this is for development use cases only.
TUI accounting system. Client/server application with two extracted open-source
libraries.
I run development like this:
## Crates
| Crate | What | Published |
|-------|------|-----------|
| `client` | TUI application, uses `tui-pages` + `tui-canvas` | No - GPLv3 |
| `server` | Backend, gRPC services | No - AGPLv3 |
| `common` | Shared protobuf types | No - GPLv3 |
| `search` | Full-text search (Tantivy) | No - AGPLv3 |
| [`tui-pages`](https://crates.io/crates/tui-pages) | Multi-page TUI navigation framework | Yes — MIT, [docs](https://tui-pages.farmeris.sk) |
| [`tui-canvas`](https://crates.io/crates/tui-canvas) | Form / textarea / text input TUI widgets | Yes — MIT |
| `tui-canvas-validation-core` | Validation primitives for `tui-canvas` | Yes — MIT |
## Development
Server and client:
Server:
```
cargo watch -x 'run --package server -- server'
```
Client:
```
cargo watch --why -x 'run --package server -- server'
cargo watch -x 'run --package client -- client'
```
Client with tracing:
```
cargo run --package client --features ui-debug -- client
cargo watch -x 'run --package client --features ui-debug -- client'
```
## License
Application code (server, search): AGPL-3.0-or-later.
Application code (client, common): GPL-3.0-or-later.
Libraries (tui-canvas, tui-pages, tui-canvas-validation-core): MIT.