FICHA · AUR

cargo-readme

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

  • cli
  • CLI
  • FILES
  • Launchable
  • Runs in terminal
official+codex · reviewed · May 30, 2026 description in en

Description

README content can be generated from Rust documentation comments in a crate. It is useful for maintainers who want public project documentation to stay close to the source docs.

This writes documentation output. Review the generated README before committing, because rustdoc comments may need context, examples, or editing for readers outside the codebase.

How to run

cargo-readme

Commands: cargo-readme

Permissions

Permissions not analysed for this source yet.