libmake

A Rust library generator that helps create high-quality Rust libraries quickly and easily.

Made With Rust Crates.io Lib.rs Docs.rs License

Welcome to the libmake Rust Library 👋

libmake Banner

Website â€ĸ Documentation â€ĸ Report Bug â€ĸ Request Feature â€ĸ Contributing Guidelines

Overview 📖

A Rust library generator that helps create high-quality Rust libraries quickly and easily.

Features ✨

Installation đŸ“Ļ

It takes just a few minutes to get up and running with the libmake Rust library.

Requirements

The minimum supported Rust toolchain version is currently Rust 1.66.1 or later (stable).

Platform support

libmake is supported and tested on the following platforms:

The GitHub Actions shows the platforms in which the libmake library tests are run.

Documentation

â„šī¸ Info: Please check out our website for more information. You can find our documentation on docs.rs, lib.rs and crates.io.

Usage 📖

To use the libmake library in your project, add the following to your Cargo.toml file:

toml [dependencies] libmake = "0.0.1"

Add the following to your main.rs file:

rust extern crate libmake; use libmake::*;

then you can use the functions in your application code.

Examples

The libmake library comes with a set of examples that you can use to get started.

Library examples are located 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.

shell cargo run --example libmake

Semantic Versioning Policy đŸšĨ

For transparency into our release cycle and in striving to maintain backward compatibility, libmake follows semantic versioning.

License 📝

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

Contribution 🤝

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

Contributions in any form (issues, pull requests, etc.) to this project must adhere to the Rust's Code of Conduct.

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 for their help and support. A special thank you goes to the Rust Reddit community for providing a lot of useful suggestions on how to improve this project.