Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,6 @@ To run the CLI via `cargo` directly, remember to add arguments after an extra
`--`; i.e., to print the general help, invoke `cargo run --relase -- -h`, or,
for a subcommand, e.g. `cargo run --relase -- me clean -h`.

This tool uses the [`clap` command line argument parser in _derive_ mode](https://docs.rs/clap/latest/clap/_derive/index.html).
To familiarize yourself with Rust and common approaches to CLI tools, take a
look at the [Rust CLI book](https://rust-cli.github.io/book/index.html).

For more understanding, see also any of these additional resources:

- <https://rust-cli-recommendations.sunshowers.io/handling-arguments.html>
- <https://github.com/kyclark/command-line-rust>
- <https://tucson-josh.com/posts/rust-clap-cli/>
- <https://www.rustadventure.dev/introducing-clap/clap-v4/parsing-arguments-with-clap>

## Milestones

- [x] bootstrap a new, general CLI, `intel_fw`, with an `me` subcommand
Expand Down
13 changes: 13 additions & 0 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,16 @@ This is both a command-line interface (CLI) and a library for

The [architecture](./architecture.md) is based on [knowledge](./knowledge.md)
from prior research.

## CLI

The CLI is made with the [`clap` command line argument parser in _derive_ mode](https://docs.rs/clap/latest/clap/_derive/index.html).
To familiarize yourself with Rust and common approaches to CLI tools, take a
look at the [Rust CLI book](https://rust-cli.github.io/book/index.html).

For more understanding, see also any of these additional resources:

- <https://rust-cli-recommendations.sunshowers.io/handling-arguments.html>
- <https://github.com/kyclark/command-line-rust>
- <https://tucson-josh.com/posts/rust-clap-cli/>
- <https://www.rustadventure.dev/introducing-clap/clap-v4/parsing-arguments-with-clap>