FICHA · MANJARO

cargo-rdme

Cargo command to create the README.md from your crate's documentation

  • tool
  • CLI
  • DOCUMENTATION
  • BUILD-SYSTEM
  • Launchable
  • Runs in terminal
official+codex · reviewed · May 27, 2026 description in en

Description

Creates or updates a README.md file from documentation written inside a Rust crate. It helps keep package documentation and repository overview aligned without maintaining two separate texts by hand.

Use it when the crate documentation is the source of truth for the README. Review generated markdown before publishing, especially when badges, examples, or project-specific sections are needed.

How to run

cargo rdme

Commands: cargo rdme

Permissions

Permissions not analysed for this source yet.