<img src="https://kura.pro/libmake/images/logos/libmake.svg"
alt="LibMake logo" width="261" align="right" />
# LibMake
A code generator to reduce repetitive tasks and build high-quality Rust
libraries.
*Part of the [Mini Functions][0] family of libraries.*
<center>
![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]
• [Website][1] • [Documentation][9] • [Report Bug][4]
• [Request Feature][4] • [Contributing Guidelines][5]
</center>
## Overview 📖
`LibMake` is a tool designed to quickly help creating high-quality Rust
libraries by generating a set of pre-filled and pre-defined templated
files. This opinionated boilerplate scaffolding tool aims to greatly
reduces development time and minimizes repetitive tasks, allowing you to
focus on your business logic while enforcing standards, best practices,
consistency, and providing style guides for your library.
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].
## Features ✨
`LibMake` offers the following features and benefits:
- Create your Rust library with ease using the command line interface or
by providing a configuration file in CSV, JSON, TOML, or YAML format.
- Rapidly generate new library projects with a pre-defined structure and
boilerplate code that you can customize with your own template.
- Generate a library pre-defined GitHub Actions workflow to help you
automate your library development and testing.
- Automatically generate basic functions, methods, and macros to get you
started with your Rust library.
- Enforce best practices and standards with starter documentation, test
suites, and benchmark suites that are designed to help you get up and
running quickly.
## Getting Started 🚀
It takes just a few seconds to get up and running with `LibMake`.
### Installation
To install `LibMake`, you need to have the Rust toolchain installed on
your machine. You can install the Rust toolchain by following the
instructions on the [Rust website][12].
Once you have the Rust toolchain installed, you can install `LibMake`
using the following command:
```shell
cargo install libmake
```
You can then run the help command to see the available options:
```shell
libmake --help
```
### Requirements
The minimum supported Rust toolchain version is currently Rust `1.69.0`
or later (stable).
### Platform support
`LibMake` is supported and has been tested on the following platforms:
### Tier 1 platforms 🏆
| ✅ | Linux | aarch64-unknown-linux-gnu | 64-bit Linux systems on ARM architecture |
| ✅ | Linux | i686-unknown-linux-gnu | 32-bit Linux (kernel 3.2+, glibc 2.17+) |
| ✅ | Linux | x86_64-unknown-linux-gnu | 64-bit Linux (kernel 2.6.32+, glibc 2.11+) |
| ✅ | macOS | x86_64-apple-darwin | 64-bit macOS (10.7 Lion or later) |
| ✅ | Windows | i686-pc-windows-gnu | 32-bit Windows (7 or later) |
| ✅ | Windows | i686-pc-windows-msvc | 32-bit Windows (7 or later) |
| ✅ | Windows | x86_64-pc-windows-gnu | 64-bit Windows (7 or later) |
| ✅ | Windows | x86_64-pc-windows-msvc | 64-bit Windows (7 or later) |
### Tier 2 platforms 🥈
| ✅ | Linux | aarch64-unknown-linux-musl | 64-bit Linux systems on ARM architecture |
| ✅ | Linux | arm-unknown-linux-gnueabi | ARMv6 Linux (kernel 3.2, glibc 2.17) |
| ✅ | Linux | arm-unknown-linux-gnueabihf | ARMv7 Linux, hardfloat (kernel 3.2, glibc 2.17) |
| ✅ | Linux | armv7-unknown-linux-gnueabihf | ARMv7 Linux, hardfloat (kernel 3.2, glibc 2.17) |
| ✅ | Linux | mips-unknown-linux-gnu | MIPS Linux (kernel 2.6.32+, glibc 2.11+) |
| ✅ | Linux | mips64-unknown-linux-gnuabi64 | MIPS64 Linux (kernel 2.6.32+, glibc 2.11+) |
| ✅ | Linux | mips64el-unknown-linux-gnuabi64 | MIPS64 Linux (kernel 2.6.32+, glibc 2.11+) |
| ✅ | Linux | mipsel-unknown-linux-gnu | MIPS Linux (kernel 2.6.32+, glibc 2.11+) |
| ✅ | macOS | aarch64-apple-darwin | 64-bit macOS (10.7 Lion or later) |
| ✅ | Windows | aarch64-pc-windows-msvc | 64-bit Windows (7 or later) |
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
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].
## Usage 📖
### Command-line interface
`LibMake` provides a command-line interface to generate a new library
project. There are a few options available to help you get started.
#### Generate a new library using a CSV file
The following command generates a library template from a CSV file.
Have a look at the `tests/data/mylibrary.csv` file for an example and
feel free to use it for your own library as a template.
```shell
libmake --csv tests/data/mylibrary.csv
```
or locally if you have cloned the repository:
```shell
cargo run -- --csv tests/data/mylibrary.csv
```
#### Generate a new library using a JSON file
The following command generates a library template from a JSON file.
Have a look at the `tests/data/mylibrary.json` file for an example and
feel free to use it for your own library as a template.
```shell
libmake --json tests/data/mylibrary.json
```
or locally if you have cloned the repository:
```shell
cargo run -- --json tests/data/mylibrary.json
```
#### Generate a new library using a TOML file
The following command generates a library template from a TOML file.
Have a look at the `tests/data/mylibrary.toml` file for an example and
feel free to use it for your own library as a template.
```shell
libmake --toml tests/data/mylibrary.toml
```
or locally if you have cloned the repository:
```shell
cargo run -- --toml tests/data/mylibrary.toml
```
#### Generate a new library using a YAML file
The following command generates a library template from a YAML file.
Have a look at the `tests/data/mylibrary.yaml` file for an example and
feel free to use it for your own library as a template.
```shell
libmake --yml tests/data/mylibrary.yaml
```
or locally if you have cloned the repository:
```shell
cargo run -- --yml tests/data/mylibrary.yaml
```
#### Generate a new library using the command-line interface (CLI) directly
The following command generates a library template using the command-line
interface.
```shell
libmake \
--author "John Smith" \
--build "build.rs" \
--categories "['category 1', 'category 2', 'category 3']" \
--description "A Rust library for doing cool things" \
--documentation "https://docs.rs/my_library" \
--edition "2021" \
--email "john.smith@example.com" \
--homepage "https://my_library.rs" \
--keywords "['rust', 'library', 'cool']" \
--license "MIT" \
--name "my_library" \
--output "my_library" \
--readme "README.md" \
--repository "https://github.com/example/my_library" \
--rustversion "1.69.0" \
--version "0.1.0" \
--website "https://example.com/john-smith"
```
or locally if you have cloned the repository:
```shell
cargo run -- --author "John Smith" \
--build "build.rs" \
--categories "['category 1', 'category 2', 'category 3']" \
--description "A Rust library for doing cool things" \
--documentation "https://docs.rs/my_library" \
--edition "2021" \
--email "john.smith@example.com" \
--homepage "https://my_library.rs" \
--keywords "['rust', 'library', 'cool']" \
--license "MIT" \
--name "my_library" \
--output "my_library" \
--readme "README.md" \
--repository "https://github.com/example/my_library" \
--rustversion "1.69.0" \
--version "0.1.0" \
--website "https://example.com/john-smith"
```
### Examples
To get started with `LibMake`, you can use the examples provided in the
`examples` directory of the project.
To run the examples, clone the repository and run the following command
in your terminal from the project root directory.
| `generate_from_args` | Generates a library template using the command-line interface. | `cargo run --example generate_from_args` |
| `generate_from_config` | Generates a library template from a configuration file. | `cargo run --example generate_from_config` |
| `generate_from_csv` | Generates a library template from a CSV file. | `cargo run --example generate_from_csv` |
| `generate_from_json` | Generates a library template from a JSON file. | `cargo run --example generate_from_json` |
| `generate_from_toml` | Generates a library template from a TOML file. | `cargo run --example generate_from_toml` |
| `generate_from_yaml` | Generates a library template from a YAML file. | `cargo run --example generate_from_yaml` |
## Semantic Versioning Policy 🚥
For transparency into our release cycle and in striving to maintain
backward compatibility, `libmake` follows [semantic versioning][7].
## 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]
## Contribution 🤝
We welcome all people who want to contribute. Please see the
[contributing instructions][5] for more information.
Contributions in any form (issues, pull requests, etc.) to this project
must adhere to the [Rust's Code of Conduct][12].
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.
## 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"
[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"
[13]: https://www.rust-lang.org "The Rust Programming Language"
[14]: https://codecov.io/gh/sebastienrousseau/libmake "Codecov"
[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'
[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.1.8-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'