Skip to content

Commit 13021dd

Browse files
committed
move notes on CLI from README to docs/intro
Signed-off-by: Daniel Maslowski <[email protected]>
1 parent e239933 commit 13021dd

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

README.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,6 @@ To run the CLI via `cargo` directly, remember to add arguments after an extra
3333
`--`; i.e., to print the general help, invoke `cargo run --relase -- -h`, or,
3434
for a subcommand, e.g. `cargo run --relase -- me clean -h`.
3535

36-
This tool uses the [`clap` command line argument parser in _derive_ mode](https://docs.rs/clap/latest/clap/_derive/index.html).
37-
To familiarize yourself with Rust and common approaches to CLI tools, take a
38-
look at the [Rust CLI book](https://rust-cli.github.io/book/index.html).
39-
40-
For more understanding, see also any of these additional resources:
41-
42-
- <https://rust-cli-recommendations.sunshowers.io/handling-arguments.html>
43-
- <https://github.com/kyclark/command-line-rust>
44-
- <https://tucson-josh.com/posts/rust-clap-cli/>
45-
- <https://www.rustadventure.dev/introducing-clap/clap-v4/parsing-arguments-with-clap>
46-
4736
## Milestones
4837

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

docs/intro.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,16 @@ This is both a command-line interface (CLI) and a library for
66

77
The [architecture](./architecture.md) is based on [knowledge](./knowledge.md)
88
from prior research.
9+
10+
## CLI
11+
12+
The CLI is made with the [`clap` command line argument parser in _derive_ mode](https://docs.rs/clap/latest/clap/_derive/index.html).
13+
To familiarize yourself with Rust and common approaches to CLI tools, take a
14+
look at the [Rust CLI book](https://rust-cli.github.io/book/index.html).
15+
16+
For more understanding, see also any of these additional resources:
17+
18+
- <https://rust-cli-recommendations.sunshowers.io/handling-arguments.html>
19+
- <https://github.com/kyclark/command-line-rust>
20+
- <https://tucson-josh.com/posts/rust-clap-cli/>
21+
- <https://www.rustadventure.dev/introducing-clap/clap-v4/parsing-arguments-with-clap>

0 commit comments

Comments
 (0)