Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GitHub Actions] Mirror README.md from src/lib.rs #7

Merged
merged 2 commits into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 75 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,75 @@
# aeruginous-io
A set of input / output utilities for the Aeruginous Open Source Development Toolbox.
<!------------------------------------------------------------------------->

[ci]: https://github.com/kevinmatthes/aeruginous-io/workflows/ci/badge.svg
[crate]: https://crates.io/crates/aeruginous-io
[crates-io]: https://img.shields.io/crates/v/aeruginous-io
[deps]: https://deps.rs/repo/github/kevinmatthes/aeruginous-io/status.svg
[deps-rs]: https://deps.rs/repo/github/kevinmatthes/aeruginous-io
[docs]: https://docs.rs/aeruginous/badge.svg
[docs-rs]: https://docs.rs/aeruginous-io
[downloads]: https://img.shields.io/crates/d/aeruginous-io
[gpl3]: https://github.com/kevinmatthes/aeruginous-io/blob/main/LICENSE
[lcns]: https://img.shields.io/github/license/kevinmatthes/aeruginous-io
[lcnss]: https://github.com/kevinmatthes/aeruginous-io/tree/main/LICENSEs
[lst]: https://img.shields.io/github/last-commit/kevinmatthes/aeruginous-io
[msrv]: https://img.shields.io/badge/MSRV-1.75.0-brightgreen
[release]: https://github.com/kevinmatthes/aeruginous-io/releases/latest
[renovate]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg
[repository]: https://github.com/kevinmatthes/aeruginous-io
[tag]: https://img.shields.io/github/v/tag/kevinmatthes/aeruginous-io

<!------------------------------------------------------------------------->

<p align = 'center'>
<a href = 'https://github.com/kevinmatthes/aeruginous-rs'>
<img
height = '200'
src =
'https://github.com/kevinmatthes/aeruginous-rs/raw/main/aeruginous.svg'
/>
</a>
<br/>
The Aeruginous Open Source Development Toolbox
</p>

## Summary

A set of input / output utilities for the Aeruginous Open Source Development
Toolbox.

[![][ci]][repository]
[![][lst]][repository]
[![][lcns]][repository]
[![][renovate]][repository]
[![][tag]][release]
<br>
[![][crates-io]][crate]
[![][deps]][deps-rs]
[![][docs]][docs-rs]
[![][downloads]][crate]
[![][msrv]][repository]

The current code coverage is **<!-- cov -->100.00%<!-- cov -->**.

## License

This project's license is **GPL-3.0**. The whole license text can be found
in [`LICENSE`][gpl3] in the repository root. The brief version is as
follows:

> Copyright (C) 2024 Kevin Matthes
>
> This program is free software: you can redistribute it and/or modify
> it under the terms of the GNU General Public License as published by
> the Free Software Foundation, either version 3 of the License, or
> (at your option) any later version.
>
> This program is distributed in the hope that it will be useful,
> but WITHOUT ANY WARRANTY; without even the implied warranty of
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> GNU General Public License for more details.
>
> You should have received a copy of the GNU General Public License
> along with this program. If not, see <https://www.gnu.org/licenses/>.

<!------------------------------------------------------------------------->
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
//! [![][downloads]][crate]
//! [![][msrv]][repository]
//!
//! The current code coverage is **<!-- cov --><!-- cov -->**.
//! The current code coverage is **<!-- cov -->100.00%<!-- cov -->**.
//!
//! ## License
//!
Expand Down