From b57aea0ec9c188868d4fbc40f4b4fa72812e1f4f Mon Sep 17 00:00:00 2001 From: Daniel Maslowski Date: Sun, 30 Nov 2025 22:34:49 +0100 Subject: [PATCH] move notes on CLI from README to docs/intro Signed-off-by: Daniel Maslowski --- README.md | 11 ----------- docs/intro.md | 13 +++++++++++++ 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 46a426b..5cdc358 100644 --- a/README.md +++ b/README.md @@ -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: - -- -- -- -- - ## Milestones - [x] bootstrap a new, general CLI, `intel_fw`, with an `me` subcommand diff --git a/docs/intro.md b/docs/intro.md index 29ba3fe..e64dbd2 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -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: + +- +- +- +-