# cargo-readme

```

Generate README.md from doc comments.

```

## Motivation

```
As you write documentation, you often have to show examples of how to use your software. But
how do you make sure your examples are all working properly? That we didn't forget to update
them after a braking change and left our (possibly new) users with errors they will have to
figure out by themselves?
```