update README

This commit is contained in:
tahahawa 2025-04-11 17:03:17 -04:00 committed by taha
parent 49b39f403b
commit 9a1eac7c8a

View File

@ -8,6 +8,24 @@ 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.
`cargo run --bin example-cli -- --help`
This is the harmony CLI, a minimal implementation
The current help text:
```
Usage: example-cli [OPTIONS] --run <RUN>
Options:
-r, --run <RUN> Name of score to run
-i, --interactive Run interactive or not
-a, --all Run all or nth
-n, --number <NUMBER> Run nth matching, zero indexed [default: 0]
-h, --help Print help
-V, --version Print version
```
## Core architecture
![Harmony Core Architecture](docs/diagrams/Harmony_Core_Architecture.drawio.svg)