Registry / build-tool / cargo-readme

cargo-readme

JSON →
library3.3.2rscratesunverified

A cargo subcommand to generate README.md content from doc comments.

# Cargo.toml [dependencies] cargo-readme = "3.3.2"
INSTALL
IMPORT
SIG · CARGO-README
C
cargo-readme
build-toolrustv3.3.2
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

generate_readme
use cargo_readme::generate_readme;

Generates a README from doc comments in a Rust source file.

use cargo_readme::generate_readme; fn main() { let readme = generate_readme("src/lib.rs").unwrap(); println!("{}", readme); }
Debug
Known issues

No known issues recorded.

Upgrade
Version history
3.3.2latest on crates.io
Audit
Dependencies

No dependency data recorded yet.

Agent activity
26 hits · last 30 days
node
22
OpenAI (training)
1
Resources
cargo-readme — cargo add cargo-readme · libregistry