Cargo rdme

Cargo command to create your README from your crate’s documentation.

Usage

Cargo rdme will insert your crate’s documentation in your README file. To control where the documentation will be inserted you need to insert a marker: <!-- cargo-rdme -->. For example, you can start your README with some glorious badges and follow up with the rustdoc documentation:

```markdown

```

After running cargo rdme you will find your README to be something like:

```markdown

```

Whenever change your crate’s documentation you just need to run cargo rdme to update your README file.

Automatic transformations

Cargo rdme will apply some automatic transformations to your documentation when generating the README file:

1. Rust code blocks starting with # will be omitted, just like in rustdoc.
2. Rust code blocks get annotated with the rust markdown tag so it gets proper syntax highlighting.

Config file

If the default behavior of cargo rdme is not appropriate for your project you can crate a configuration file .cargo-rdme.toml in the root of your project. This is how that configuration file can look like:

```toml

What line terminator to use when updating the README file. This can be "lf" or "crlf".

line-terminator = "lf"

The default entrypoint will be src/lib.rs. You can change that in the entrypoint table.

[entrypoint]

The entrypoint type can be "lib" or "bin".

type = "bin"

When you set type to "bin" the entrypoint default to src/main.rs. If you have binary targets

specified in your cargo manifest you can select them by name with bin-name.

bin-name = "my-bin-name" ```

These setting can be overridden with command line flags. Run cargo rdme --help for more information.

Integration with CI

To verify that your README is up to date with your crate’s documentation you can run cargo rdme --check. The exit code will be 0 if the README is up to date, or 2 if it’s not.