This repository has been archived by the owner on Mar 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sync documentation with lessons learned from spellout
Since the README files get published to other platforms like crates.io, we want to use absolute URLs because otherwise the relative links to things like our LICENSE files will be broken. I also shuffled around the various sections based on the binary being the main project of the repository, that relies on a published library.
- Loading branch information
1 parent
5aa6b58
commit 945ccb1
Showing
3 changed files
with
68 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,45 +1,48 @@ | ||
# 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 | ||
<https://earthmanmuons.github.io/rustops-blueprint/> | ||
## 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 | ||
|
||
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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
<https://earthmanmuons.github.io/rustops-blueprint/mylib/index.html>. | ||
|
||
## 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 |