Skip to content

Commit

Permalink
docs(README): update release steps
Browse files Browse the repository at this point in the history
  • Loading branch information
onkoe committed Sep 4, 2024
1 parent 693fe2f commit 7625f45
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ There are a few ground rules, though:

### Making a Release

The only note I have for now is to generate the README using `cargo-rdme`. The crate includes a configuration file for this tool, so it should just work.
There are only a few steps to releasing this crate.

1. Generate the `README.md` file using `cargo-rdme`.
1. Change the version numbers in `/Cargo.toml` and `/macros/Cargo.toml`.
1. Run `cargo publish`!

<!-- cargo-rdme end -->
6 changes: 5 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,11 @@ There are a few ground rules, though:
### Making a Release
The only note I have for now is to generate the README using `cargo-rdme`. The crate includes a configuration file for this tool, so it should just work.
There are only a few steps to releasing this crate.
1. Generate the `README.md` file using `cargo-rdme`.
1. Change the version numbers in `/Cargo.toml` and `/macros/Cargo.toml`.
1. Run `cargo publish`!
*/

#[cfg(doctest)]
Expand Down

0 comments on commit 7625f45

Please sign in to comment.