orium / cargo-rdme

Cargo command to create the README.md from your crate's documentation
Mozilla Public License 2.0
126 stars 5 forks source link

Exit with non-zero code when no marker is found on the README #238

Open stepancheg opened 2 months ago

stepancheg commented 2 months ago
$ cargo rdme
No marker found in the README file (README.md).

cargo-rdme expects a marker in the README where the crate’s documentation will
be inserted.  This is the marker you should add to your README:

<!-- cargo-rdme -->

$ echo $?
0