commit 21ccabe1dfd06b69b1f1fe9faeb82c9e6da8d6b2 from: murilo ijanc date: Sat Nov 22 13:52:45 2025 UTC Improve README to add default sections when template is cli commit - e097527979bd6f5aa28c8e587ffc986558a0ea2e commit + 21ccabe1dfd06b69b1f1fe9faeb82c9e6da8d6b2 blob - 3dcf61b571e7e37cb3e85018179e3d5e8667907e blob + ea0d3ef7f0dbe488a7cadb73a796eb502ec5f824 --- cli/template/README.md +++ cli/template/README.md @@ -1,11 +1,80 @@ # {{project-name}} -## Run +`{{project-name}}` {{project-description}} +## Why + +## Features + +- Feature 1 +- Feature 2 +- Feature 3 + +## Requirements + +- Rust toolchain (Rust 1.89 or newer recommended) + +To install Rust: + +```sh +curl https://sh.rustup.rs -sSf | sh ``` -RUST_LOG=debug cargo run + +Verify installation: + +```sh +rustc --version +cargo --version ``` +## Building + +Clone the repository and build the binary: + +```sh +git clone ssh://anon@ijanc.org/{{project-name}} +cd {{project-name}} +cargo build --release +``` + +The binary will be located at: + +``` +target/release/{{project-name}} +``` + +You can add it to your PATH, move it to `/usr/local/bin`. + +or + +``` +cargo install --path . +``` + +## Command Overview + +`{{project-name}}` currently supports one primary operation: + +### Command 1 + +## Logging and verbosity + +`{{project-name}}` uses `tracing` for structured logging. + +By default, logs are shown at the INFO level.\ +Use `-v` to enable DEBUG logs: + +``` +{{project-name}} -v ... +``` + +Or configure via `RUST_LOG`: + +``` +RUST_LOG=debug {{project-name}} ... +``` + ## License -This project is licensed under the ISC license ([LICENSE](LICENSE) or http://opensource.org/licenses/ISC) +This project is licensed under the ISC license ([LICENSE](LICENSE) or\ +http://opensource.org/licenses/ISC)