Skip to content

Commit 533919d

Browse files
committed
README: add notes on development
Signed-off-by: Daniel Maslowski <[email protected]>
1 parent cba8d14 commit 533919d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@ Based on knowledge from [`me_cleaner`](https://github.com/corna/me_cleaner),
77
`intel_fw` is written from scratch in Rust, allowing for integration with other
88
projects, including a programmatic API.
99

10+
## Development
11+
12+
To run the CLI via `cargo` directly, remember to add arguments after an extra
13+
`--`; i.e., to print the general help, invoke `cargo run --relase -- -h`, or,
14+
for a subcommand, e.g. `cargo run --relase -- me clean -h`.
15+
16+
This tool uses the [`clap` command line argument parser in _derive_ mode](https://docs.rs/clap/latest/clap/_derive/index.html).
17+
To familiarize yourself with Rust and common approaches to CLI tools, take a
18+
look at the [Rust CLI book](https://rust-cli.github.io/book/index.html).
19+
20+
For more understanding, see also any of these additional resources:
21+
- <https://rust-cli-recommendations.sunshowers.io/handling-arguments.html>
22+
- <https://github.com/kyclark/command-line-rust>
23+
- <https://tucson-josh.com/posts/rust-clap-cli/>
24+
- <https://www.rustadventure.dev/introducing-clap/clap-v4/parsing-arguments-with-clap>
25+
1026
## Milestones
1127

1228
- [ ] bootstrap a new, general CLI, `intel_fw`, with an `me` subcommand

0 commit comments

Comments
 (0)