docs: add quick demo and core architecture overview

Adds a quick demo command using `cargo run -p example-tui` to launch a minimalist TUI with demo scores.

Also includes a core architecture diagram and overview in the README for better understanding of the project structure.
This commit is contained in:
Jean-Gabriel Gill-Couture 2025-04-09 16:09:54 -04:00
parent 1cbf4de2a1
commit 31ae8365a6
2 changed files with 14 additions and 6 deletions

View File

@ -1,9 +1,13 @@
### Watch the whole repo on every change # Harmony : Open Infrastructure Orchestration
Due to the current setup being a mix of separate repositories with gitignore and rust workspace, a few options are required for cargo-watch to have the desired behavior : ## Quick demo
```sh `cargo run -p example-tui`
RUST_LOG=info cargo watch --ignore-nothing -w harmony -w private_repos/ -x 'run --bin nationtech'
```
This will run the nationtech bin (likely `private_repos/nationtech/src/main.rs`) on any change in the harmony or private_repos folders. This will launch Harmony's minimalist terminal ui which embeds a few demo scores.
Usage instructions will be displayed at the bottom of the TUI.
## Core architecture
![Harmony Core Architecture](docs/diagrams/Harmony_Core_Architecture.drawio.svg)

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 1.1 MiB