diff --git a/README.md b/README.md index 25a6ce3..1bc4fcd 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,39 @@ -# RustOps Blueprint   [![CI Status]][actions] [![MSRV]][rust-version] - -[CI Status]: - https://img.shields.io/github/actions/workflow/status/EarthmanMuons/rustops-blueprint/on-pull-request.yml?event=merge_group&label=CI&logo=github -[actions]: - https://github.com/EarthmanMuons/rustops-blueprint/actions?query=event%3Amerge_group -[MSRV]: https://img.shields.io/badge/MSRV-1.64-blue -[rust-version]: - https://doc.rust-lang.org/cargo/reference/manifest.html#the-rust-version-field +# RustOps Blueprint **A GitHub repository template for a polished Rust development experience.** +[![CI status](https://img.shields.io/github/actions/workflow/status/EarthmanMuons/rustops-blueprint/on-pull-request.yml?event=merge_group&label=ci&logo=github)](https://github.com/EarthmanMuons/rustops-blueprint/actions?query=event%3Amerge_group) + --- -## Documentation +## Usage + +TBD -Generated [Rustdoc][] reference documentation can be found at - +## Installation -[Rustdoc]: https://doc.rust-lang.org/stable/rustdoc/ +### Building from Source -## Minimum Supported Rust Version (MSRV) Policy +After [installing Rust][], to build the binary and install it on your system +under the `~/.cargo/bin/` directory, run the following command: -- We follow an "N-2 policy," supporting at least the current stable Rust release - and the two preceding versions. -- Our MSRV only advances when we adopt a feature from a newer Rust version. We - do not increase the MSRV systematically with each new release of Rust. -- MSRV increases are considered regular changes, not breaking changes, in terms - of Semantic Versioning. +``` +cargo install --locked --git https://github.com/EarthmanMuons/rustops-blueprint/ mybin +``` + +[installing Rust]: https://www.rust-lang.org/learn/get-started ## License RustOps Blueprint is distributed under the terms of both the Apache License (Version 2.0) and the MIT License. -See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details. +See [LICENSE-APACHE][] and [LICENSE-MIT][] for details. + +[LICENSE-APACHE]: + https://github.com/EarthmanMuons/rustops-blueprint/blob/main/LICENSE-APACHE +[LICENSE-MIT]: + https://github.com/EarthmanMuons/rustops-blueprint/blob/main/LICENSE-MIT ## Contribution @@ -41,5 +41,8 @@ Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. -If you would like to contribute to the project, please read our -[guide for contributors](CONTRIBUTING.md). +If you would like to contribute to the project, please read our [guide for +contributors][CONTRIBUTING.md]. + +[CONTRIBUTING.md]: + https://github.com/EarthmanMuons/rustops-blueprint/blob/main/CONTRIBUTING.md diff --git a/crates/mybin/README.md b/crates/mybin/README.md deleted file mode 100644 index 3b90f89..0000000 --- a/crates/mybin/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# mybin - -My binary description. - -## Installation - -To build the binary and install it on your system under the `~/.cargo/bin` -directory, run the following command: - -``` -cargo install --locked --git https://github.com/EarthmanMuons/rustops-blueprint/ mybin -``` - -## Usage - - $ mybin - Hello, world! 10 plus 32 is 42! - Unshuffled: [1, 2, 3, 4, 5] - Shuffled: [1, 3, 5, 4, 2] diff --git a/crates/mylib/README.md b/crates/mylib/README.md index c4b4ad2..be9b6f5 100644 --- a/crates/mylib/README.md +++ b/crates/mylib/README.md @@ -1,20 +1,58 @@ # mylib -My library description. +**My library description.** + +[![CI status](https://img.shields.io/github/actions/workflow/status/EarthmanMuons/rustops-blueprint/on-pull-request.yml?event=merge_group&label=ci&logo=github)](https://github.com/EarthmanMuons/rustops-blueprint/actions?query=event%3Amerge_group) +[![crates.io](https://img.shields.io/crates/v/mylib)](https://crates.io/crates/mylib/) +[![docs.rs](https://img.shields.io/docsrs/mylib)](https://docs.rs/spellabet/0.1.0/mylib/) +[![MSRV](https://img.shields.io/badge/rust-1.64%2B-blue)](https://doc.rust-lang.org/cargo/reference/manifest.html#the-rust-version-field) + +--- ## Usage -Add this to your `Cargo.toml`: +To use the crate, add it as dependency in your `Cargo.toml` file: ```toml [dependencies] mylib = "0.1.0" ``` +## Documentation + +For detailed examples of using this library, along with the latest generated API +reference documentation, please visit +. + +## Minimum Supported Rust Version (MSRV) Policy + +- We follow an "N-2 policy," supporting at least the current stable Rust release + and the two preceding versions. +- Our MSRV only advances when we adopt a feature from a newer Rust version. We + do not increase the MSRV systematically with each new release of Rust. +- MSRV increases are considered regular changes, not breaking changes, in terms + of Semantic Versioning. + ## License mylib is distributed under the terms of both the Apache License (Version 2.0) and the MIT License. -See [LICENSE-APACHE](../../LICENSE-APACHE) and [LICENSE-MIT](../../LICENSE-MIT) -for details. +See [LICENSE-APACHE][] and [LICENSE-MIT][] for details. + +[LICENSE-APACHE]: + https://github.com/EarthmanMuons/rustops-blueprint/blob/main/LICENSE-APACHE +[LICENSE-MIT]: + https://github.com/EarthmanMuons/rustops-blueprint/blob/main/LICENSE-MIT + +## Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +If you would like to contribute to the project, please read our [guide for +contributors][CONTRIBUTING.md]. + +[CONTRIBUTING.md]: + https://github.com/EarthmanMuons/rustops-blueprint/blob/main/CONTRIBUTING.md