Skip to content

Commit

Permalink
fix(libmake): 📝 minor tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastienrousseau committed Nov 7, 2023
1 parent 771cad2 commit 669e3a2
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 55 deletions.
65 changes: 32 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ alt="LibMake logo" width="261" align="right" />

A code generator to reduce repetitive tasks and build high-quality Rust libraries.

*Part of the [Mini Functions][0] family of libraries.*
*Part of the [Mini Functions][00] family of libraries.*

<!-- markdownlint-disable MD033 MD041 -->
<center>
<!-- markdownlint-enable MD033 MD041 -->

![Banner of Libmake][banner]

[![Made With Rust][made-with-rust-badge]][13] [![Crates.io][crates-badge]][8] [![Lib.rs][libs-badge]][10] [![Docs.rs][docs-badge]][9] [![License][license-badge]][3] [![Codecov][codecov-badge]][14]
[![Made With Rust][made-with-rust-badge]][13] [![Crates.io][crates-badge]][08] [![Lib.rs][libs-badge]][10] [![Docs.rs][docs-badge]][09] [![License][license-badge]][03] [![Codecov][codecov-badge]][14]

[Website][1][Documentation][9][Report Bug][4][Request Feature][4][Contributing Guidelines][5]
[Website][01][Documentation][09][Report Bug][04][Request Feature][04][Contributing Guidelines][05]

<!-- markdownlint-disable MD033 MD041 -->
</center>
Expand All @@ -34,7 +34,7 @@ A code generator to reduce repetitive tasks and build high-quality Rust librarie

With `LibMake`, you can easily generate a new Rust library code base structure with all the necessary files, layouts, build configurations, code, tests, benchmarks, documentation, and much more in a matter of seconds.

The library is designed to be used as a command-line tool. It is available on [Crates.io][7] and [Lib.rs][8].
The library is designed to be used as a command-line tool. It is available on [Crates.io][07] and [Lib.rs][08].

## Table of Contents

Expand Down Expand Up @@ -135,15 +135,15 @@ The [GitHub Actions][11] shows the platforms in which the `LibMake`
library tests are run.

Should you encounter any issues with the library on any of the above
platforms, please [report a bug][4]. We will do our best to resolve the
platforms, please [report a bug][04]. We will do our best to resolve the
issue as soon as possible. If you would like to contribute to help us to
support additional platforms, please submit a pull request.

### Documentation

> ℹ️ **Info:** Do check out our [website][1] for more information. You
can find our documentation on [docs.rs][9], [lib.rs][10] and
[crates.io][8].
> ℹ️ **Info:** Do check out our [website][01] for more information. You
can find our documentation on [docs.rs][09], [lib.rs][10] and
[crates.io][08].

## Usage

Expand Down Expand Up @@ -288,20 +288,20 @@ in your terminal from the project root directory.
## Semantic Versioning Policy

For transparency into our release cycle and in striving to maintain
backward compatibility, `libmake` follows [semantic versioning][7].
backward compatibility, `libmake` follows [semantic versioning][07].

## License

The project is licensed under the terms of both the MIT license and the
Apache License (Version 2.0).

- [Apache License, Version 2.0][2]
- [MIT license][3]
- [Apache License, Version 2.0][02]
- [MIT license][03]

## Contribution

We welcome all people who want to contribute. Please see the
[contributing instructions][5] for more information.
[contributing instructions][05] for more information.

Contributions in any form (issues, pull requests, etc.) to this project
must adhere to the [Rust's Code of Conduct][12].
Expand All @@ -313,21 +313,20 @@ additional terms or conditions.

## Acknowledgements

A big thank you to all the awesome contributors of [libmake][6] for
their help and support. A special thank you goes to the
[Rust Reddit][15] community for providing a lot of useful suggestions on how to improve
this project.

[0]: https://minifunctions.com/libmake "Mini Functions"
[1]: https://libmake.com "LibMake"
[2]: https://opensource.org/license/apache-2-0/ "Apache License, Version 2.0"
[3]: http://opensource.org/licenses/MIT "MIT license"
[4]: https://github.com/sebastienrousseau/libmake/issues "Issues"
[5]: https://github.com/sebastienrousseau/libmake/blob/main/CONTRIBUTING.md "Contributing"
[6]: https://github.com/sebastienrousseau/libmake/graphs/contributors "Contributors"
[7]: http://semver.org/ "Semantic Versioning"
[8]: https://crates.io/crates/libmake "LibMake on crates.io"
[9]: https://docs.rs/libmake "LibMake on docs.rs"
A big thank you to all the awesome contributors of [libmake][06] for their help
and support. A special thank you goes to the [Rust Reddit][15] community for
providing a lot of useful suggestions on how to improve this project.

[00]: https://minifunctions.com/libmake "Mini Functions"
[01]: https://libmake.com "LibMake"
[02]: https://opensource.org/license/apache-2-0/ "Apache License, Version 2.0"
[03]: http://opensource.org/licenses/MIT "MIT license"
[04]: https://github.com/sebastienrousseau/libmake/issues "Issues"
[05]: https://github.com/sebastienrousseau/libmake/blob/main/CONTRIBUTING.md "Contributing"
[06]: https://github.com/sebastienrousseau/libmake/graphs/contributors "Contributors"
[07]: http://semver.org/ "Semantic Versioning"
[08]: https://crates.io/crates/libmake "LibMake on crates.io"
[09]: https://docs.rs/libmake "LibMake on docs.rs"
[10]: https://lib.rs/crates/libmake "LibMake on lib.rs"
[11]: https://github.com/sebastienrousseau/libmake/actions "GitHub Actions"
[12]: https://www.rust-lang.org/policies/code-of-conduct "Rust's Code of Conduct"
Expand All @@ -336,10 +335,10 @@ this project.
[15]: https://www.reddit.com/r/rust/ "Rust Reddit"

[banner]: https://kura.pro/libmake/images/titles/title-libmake.svg "LibMake Banner"
[codecov-badge]: https://img.shields.io/codecov/c/github/sebastienrousseau/libmake?style=for-the-badge&token=Q9KJ6XXL67 'Codecov'
[crates-badge]: https://img.shields.io/crates/v/libmake.svg?style=for-the-badge 'Crates.io Badge'
[codecov-badge]: https://img.shields.io/codecov/c/github/sebastienrousseau/libmake?style=for-the-badge&token=Q9KJ6XXL67 "Codecov Badge"
[crates-badge]: https://img.shields.io/crates/v/libmake.svg?style=for-the-badge "Crates.io Badge"
[divider]: https://kura.pro/common/images/elements/divider.svg "divider"
[docs-badge]: https://img.shields.io/docsrs/libmake.svg?style=for-the-badge 'Docs.rs Badge'
[libs-badge]: https://img.shields.io/badge/lib.rs-v0.2.0-orange.svg?style=for-the-badge 'Lib.rs Badge'
[license-badge]: https://img.shields.io/crates/l/libmake.svg?style=for-the-badge 'License Badge'
[made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust 'Made With Rust Badge'
[docs-badge]: https://img.shields.io/docsrs/libmake.svg?style=for-the-badge "Docs.rs Badge"
[libs-badge]: https://img.shields.io/badge/lib.rs-v0.2.0-orange.svg?style=for-the-badge "Lib.rs Badge"
[license-badge]: https://img.shields.io/crates/l/libmake.svg?style=for-the-badge "License Badge"
[made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust "Made With Rust Badge"
44 changes: 22 additions & 22 deletions TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ alt="LibMake logo" width="261" align="right" />

A code generator to reduce repetitive tasks and build high-quality Rust libraries.

*Part of the [Mini Functions][0] family of libraries.*
*Part of the [Mini Functions][00] family of libraries.*

<!-- markdownlint-disable MD033 MD041 -->
<center>
<!-- markdownlint-enable MD033 MD041 -->

![Libmake Banner][banner]

[![Made With Rust][made-with-rust-badge]][13] [![Crates.io][crates-badge]][8] [![Lib.rs][libs-badge]][10] [![Docs.rs][docs-badge]][9]
[![License][license-badge]][3] [![Codecov][codecov-badge]][14]
[![Made With Rust][made-with-rust-badge]][09] [![Crates.io][crates-badge]][06] [![Lib.rs][libs-badge]][08] [![Docs.rs][docs-badge]][07]
[![License][license-badge]][02] [![Codecov][codecov-badge]][10]

[Website][1][Documentation][9][Report Bug][4][Request Feature][4][Contributing Guidelines][5]
[Website][01][Documentation][07][Report Bug][03][Request Feature][03][Contributing Guidelines][04]

<!-- markdownlint-disable MD033 MD041 -->
</center>
Expand All @@ -33,7 +33,7 @@ A code generator to reduce repetitive tasks and build high-quality Rust librarie

With `LibMake`, you can easily generate a new Rust library code base structure with all the necessary files, layouts, build configurations, code, tests, benchmarks, documentation, and much more in a matter of seconds.

The library is designed to be used as a command-line tool. It is available on [Crates.io][7] and [Lib.rs][8].
The library is designed to be used as a command-line tool. It is available on [Crates.io][05] and [Lib.rs][06].

## Features ✨

Expand All @@ -47,22 +47,22 @@ The library is designed to be used as a command-line tool. It is available on [C

## Changelog 📚

[0]: https://minifunctions.com/libmake "Mini Functions"
[1]: https://libmake.com "LibMake"
[3]: http://opensource.org/licenses/MIT "MIT license"
[4]: https://github.com/sebastienrousseau/libmake/issues "Issues"
[5]: https://github.com/sebastienrousseau/libmake/blob/main/CONTRIBUTING.md "Contributing"
[7]: http://semver.org/ "Semantic Versioning"
[8]: https://crates.io/crates/libmake "LibMake on crates.io"
[9]: https://docs.rs/libmake "LibMake on docs.rs"
[10]: https://lib.rs/crates/libmake "LibMake on lib.rs"
[13]: https://www.rust-lang.org "The Rust Programming Language"
[14]: https://codecov.io/gh/sebastienrousseau/libmake "Codecov"
[00]: https://minifunctions.com/libmake "Mini Functions"
[01]: https://libmake.com "LibMake"
[02]: http://opensource.org/licenses/MIT "MIT license"
[03]: https://github.com/sebastienrousseau/libmake/issues "Issues"
[04]: https://github.com/sebastienrousseau/libmake/blob/main/CONTRIBUTING.md "Contributing"
[05]: http://semver.org/ "Semantic Versioning"
[06]: https://crates.io/crates/libmake "LibMake on Crates.io"
[07]: https://docs.rs/libmake "LibMake on docs.rs"
[08]: https://lib.rs/crates/libmake "LibMake on lib.rs"
[09]: https://www.rust-lang.org "The Rust Programming Language"
[10]: https://codecov.io/gh/sebastienrousseau/libmake "Codecov"

[banner]: https://kura.pro/libmake/images/titles/title-libmake.svg "LibMake Banner"
[codecov-badge]: https://img.shields.io/codecov/c/github/sebastienrousseau/libmake?style=for-the-badge&token=Q9KJ6XXL67 'Codecov'
[crates-badge]: https://img.shields.io/crates/v/libmake.svg?style=for-the-badge 'Crates.io Badge'
[docs-badge]: https://img.shields.io/docsrs/libmake.svg?style=for-the-badge 'Docs.rs Badge'
[libs-badge]: https://img.shields.io/badge/lib.rs-v0.2.0-orange.svg?style=for-the-badge 'Lib.rs Badge'
[license-badge]: https://img.shields.io/crates/l/libmake.svg?style=for-the-badge 'License Badge'
[made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust 'Made With Rust Badge'
[codecov-badge]: https://img.shields.io/codecov/c/github/sebastienrousseau/libmake?style=for-the-badge&token=Q9KJ6XXL67 "Codecov Badge"
[crates-badge]: https://img.shields.io/crates/v/libmake.svg?style=for-the-badge "Crates.io Badge"
[docs-badge]: https://img.shields.io/docsrs/libmake.svg?style=for-the-badge "Docs.rs Badge"
[libs-badge]: https://img.shields.io/badge/lib.rs-v0.2.0-orange.svg?style=for-the-badge "Lib.rs Badge"
[license-badge]: https://img.shields.io/crates/l/libmake.svg?style=for-the-badge "License Badge"
[made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust "Made With Rust Badge"

0 comments on commit 669e3a2

Please sign in to comment.