{"id":13539512,"url":"https://github.com/sebastienrousseau/libmake","last_synced_at":"2025-04-30T09:16:15.898Z","repository":{"id":81401430,"uuid":"604600178","full_name":"sebastienrousseau/libmake","owner":"sebastienrousseau","description":"A code generator to reduce repetitive tasks and build high-quality Rust libraries. 🦀","archived":false,"fork":false,"pushed_at":"2024-05-15T23:50:57.000Z","size":2530,"stargazers_count":30,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-30T09:15:52.332Z","etag":null,"topics":["boilerplate","code-generation","library-generation","library-generator","rust","rust-library","scaffolding","starter-kit","starter-template","templates"],"latest_commit_sha":null,"homepage":"http://docs.libmake.com/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sebastienrousseau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/funding.yml","license":"LICENSE-APACHE","code_of_conduct":".github/CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"sebastienrousseau","custom":"https://paypal.me/wwdseb"}},"created_at":"2023-02-21T12:03:26.000Z","updated_at":"2025-03-12T15:43:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"53691055-e469-4776-9425-fb644bc7872c","html_url":"https://github.com/sebastienrousseau/libmake","commit_stats":{"total_commits":183,"total_committers":3,"mean_commits":61.0,"dds":"0.10382513661202186","last_synced_commit":"1ad7e249ac7b25cc9ba8b9d6d042d87e03e63aa6"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastienrousseau%2Flibmake","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastienrousseau%2Flibmake/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastienrousseau%2Flibmake/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastienrousseau%2Flibmake/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sebastienrousseau","download_url":"https://codeload.github.com/sebastienrousseau/libmake/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251674586,"owners_count":21625645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","code-generation","library-generation","library-generator","rust","rust-library","scaffolding","starter-kit","starter-template","templates"],"created_at":"2024-08-01T09:01:27.021Z","updated_at":"2025-04-30T09:16:15.851Z","avatar_url":"https://github.com/sebastienrousseau.png","language":"Rust","funding_links":["https://github.com/sponsors/sebastienrousseau","https://paypal.me/wwdseb"],"categories":["Rust"],"sub_categories":[],"readme":"\u003c!-- markdownlint-disable MD033 MD041 --\u003e\n\n\u003cimg src=\"https://kura.pro/libmake/images/logos/libmake.webp\"\nalt=\"LibMake logo\" width=\"261\" align=\"right\" /\u003e\n\n\u003c!-- markdownlint-enable MD033 MD041 --\u003e\n# LibMake\n\nA code generator to reduce repetitive tasks and build high-quality Rust libraries.\n\n*Part of the [Mini Functions][00] family of libraries.*\n\n\u003c!-- markdownlint-disable MD033 MD041 --\u003e\n\u003ccenter\u003e\n\u003c!-- markdownlint-enable MD033 MD041 --\u003e\n\n![Banner of Libmake][banner]\n\n[![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]\n\n• [Website][01] • [Documentation][09] • [Report Bug][04] • [Request Feature][04] • [Contributing Guidelines][05]\n\n\u003c!-- markdownlint-disable MD033 MD041 --\u003e\n\u003c/center\u003e\n\u003c!-- markdownlint-enable MD033 MD041 --\u003e\n\n\u003c!-- markdownlint-enable MD033 --\u003e\n\n![divider][divider]\n\n## Overview\n\n`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 reduce 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.\n\nWith `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.\n\nThe library is designed to be used as a command-line tool. It is available on [Crates.io][07] and [Lib.rs][08].\n\n## Table of Contents\n\n- [LibMake](#libmake)\n  - [Overview](#overview)\n  - [Table of Contents](#table-of-contents)\n  - [Features](#features)\n  - [Getting Started](#getting-started)\n    - [Prerequisites](#prerequisites)\n    - [Installation](#installation)\n    - [Requirements](#requirements)\n      - [Tier 1 platforms](#tier-1-platforms)\n      - [Tier 2 platforms](#tier-2-platforms)\n    - [Documentation](#documentation)\n  - [Usage](#usage)\n    - [Command-line interface](#command-line-interface)\n      - [Passing a configuration file](#passing-a-configuration-file)\n        - [Generate a new library using a CSV file](#generate-a-new-library-using-a-csv-file)\n        - [Generate a new library using an INI file](#generate-a-new-library-using-an-ini-file)\n        - [Generate a new library using a JSON file](#generate-a-new-library-using-a-json-file)\n        - [Generate a new library using a TOML file](#generate-a-new-library-using-a-toml-file)\n        - [Generate a new library using a YAML file](#generate-a-new-library-using-a-yaml-file)\n      - [Generate a new library using the command-line interface (CLI) directly](#generate-a-new-library-using-the-command-line-interface-cli-directly)\n    - [Examples](#examples)\n  - [Semantic Versioning Policy](#semantic-versioning-policy)\n  - [License](#license)\n  - [Contribution](#contribution)\n  - [Acknowledgements](#acknowledgements)\n\n## Features\n\n`LibMake` offers the following features and benefits:\n\n- **Simplicity**: Create Rust libraries effortlessly via CLI or configuration files in CSV, JSON, TOML, or YAML.\n- **Speed**: Instantly scaffold new libraries with a standard structure and essential boilerplate.\n- **Automation**: Generate predefined GitHub Actions workflows for streamlined development and testing.\n- **Foundation**: Jumpstart your project with automatically generated functions, methods, and macros.\n- **Standards**: Embrace best practices from the start with starter documentation, tests, and benchmarks.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nYou will need Rust and Cargo installed on your system. If you don't have them installed, you can install them from the official Rust website.\n\nIt takes just a few seconds to get up and running with `LibMake`.\n\n### Installation\n\nOnce you have the Rust toolchain installed, you can install `LibMake`\nusing the following command:\n\n```shell\ncargo install libmake\n```\n\nYou can then run the help command to see the available options:\n\n```shell\nlibmake --help\n```\n\n### Requirements\n\nThe minimum supported Rust toolchain version is currently Rust `1.60` or later (stable).\n\n`LibMake` is supported and has been tested on the following platforms:\n\n#### Tier 1 platforms\n\nRust Tier 1 targets are officially supported and guaranteed to work.\n\n| | Operating System | Target | Description |\n| --- | --- | --- | --- |\n| ✅ | Linux   | aarch64-unknown-linux-gnu | 64-bit Linux systems on ARM architecture |\n| ✅ | Linux   | i686-unknown-linux-gnu | 32-bit Linux (kernel 3.2+, glibc 2.17+) |\n| ✅ | Linux   | x86_64-unknown-linux-gnu | 64-bit Linux (kernel 2.6.32+, glibc 2.11+) |\n| ✅ | macOS   | x86_64-apple-darwin | 64-bit macOS (10.7 Lion or later) |\n| ✅ | Windows | i686-pc-windows-gnu | 32-bit Windows (7 or later) |\n| ✅ | Windows | i686-pc-windows-msvc | 32-bit Windows (7 or later) |\n| ✅ | Windows | x86_64-pc-windows-gnu | 64-bit Windows (7 or later) |\n| ✅ | Windows | x86_64-pc-windows-msvc | 64-bit Windows (7 or later) |\n\n#### Tier 2 platforms\n\nRust Tier 2 targets are supported for building, but not necessarily running.\n\n| | Operating System | Target | Description |\n| --- | --- | --- | --- |\n| ✅ | Linux   | aarch64-unknown-linux-musl | 64-bit Linux systems on ARM architecture |\n| ✅ | Linux   | arm-unknown-linux-gnueabi | ARMv6 Linux (kernel 3.2, glibc 2.17) |\n| ✅ | Linux   | arm-unknown-linux-gnueabihf | ARMv7 Linux, hardfloat (kernel 3.2, glibc 2.17) |\n| ✅ | Linux   | armv7-unknown-linux-gnueabihf | ARMv7 Linux, hardfloat (kernel 3.2, glibc 2.17) |\n| ✅ | macOS   | aarch64-apple-darwin | 64-bit macOS (10.7 Lion or later) |\n| ✅ | Windows | aarch64-pc-windows-msvc | 64-bit Windows (7 or later) |\n\nThe [GitHub Actions][11] shows the platforms in which the `LibMake`\nlibrary tests are run.\n\nShould you encounter any issues with the library on any of the above\nplatforms, please [report a bug][04]. We will do our best to resolve the\nissue as soon as possible. If you would like to contribute to help us to\nsupport additional platforms, please submit a pull request.\n\n### Documentation\n\n**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].\n\n## Usage\n\n### Command-line interface\n\n`LibMake` provides a command-line interface to generate a new library project. There are a few options available to help you get started.\n\n#### Passing a configuration file\n\n##### Generate a new library using a CSV file\n\nThe following command generates a library template from a CSV file.\n\nHave a look at the `tests/data/mylibrary.csv` file for an example and\nfeel free to use it for your own library as a template.\n\n```shell\nlibmake file --csv tests/data/mylibrary.csv\n```\n\nor locally if you have cloned the repository:\n\n```shell\ncargo run -- file --csv tests/data/mylibrary.csv\n```\n\n##### Generate a new library using an INI file\n\nThe following command generates a library template from an INI file.\n\nHave a look at the `tests/data/mylibrary.ini` file for an example and\nfeel free to use it for your own library as a template.\n\n```shell\nlibmake file --ini tests/data/mylibrary.ini\n```\n\nor locally if you have cloned the repository:\n\n```shell\ncargo run -- file --ini tests/data/mylibrary.ini\n```\n\n##### Generate a new library using a JSON file\n\nThe following command generates a library template from a JSON file.\n\nHave a look at the `tests/data/mylibrary.json` file for an example and\nfeel free to use it for your own library as a template.\n\n```shell\nlibmake file --json tests/data/mylibrary.json\n```\n\nor locally if you have cloned the repository:\n\n```shell\ncargo run -- file --json tests/data/mylibrary.json\n```\n\n##### Generate a new library using a TOML file\n\nThe following command generates a library template from a TOML file.\n\nHave a look at the `tests/data/mylibrary.toml` file for an example and\nfeel free to use it for your own library as a template.\n\n```shell\nlibmake file --toml tests/data/mylibrary.toml\n```\n\nor locally if you have cloned the repository:\n\n```shell\ncargo run -- file --toml tests/data/mylibrary.toml\n```\n\n##### Generate a new library using a YAML file\n\nThe following command generates a library template from a YAML file.\n\nHave a look at the `tests/data/mylibrary.yaml` file for an example and\nfeel free to use it for your own library as a template.\n\n```shell\nlibmake file --yaml tests/data/mylibrary.yaml\n```\n\nor locally if you have cloned the repository:\n\n```shell\ncargo run -- file --yaml tests/data/mylibrary.yaml\n```\n\n#### Generate a new library using the command-line interface (CLI) directly\n\nThe following command generates a library template using the command-line\ninterface.\n\n```shell\nlibmake manual\\\n    --author \"John Smith\" \\\n    --build \"build.rs\" \\\n    --categories \"['category 1', 'category 2', 'category 3']\" \\\n    --description \"A Rust library for doing cool things\" \\\n    --documentation \"https://docs.rs/my_library\" \\\n    --edition \"2021\" \\\n    --email \"john.smith@example.com\" \\\n    --homepage \"https://my_library.rs\" \\\n    --keywords \"['rust', 'library', 'cool']\" \\\n    --license \"MIT\" \\\n    --name \"my_library\" \\\n    --output \"my_library\" \\\n    --readme \"README.md\" \\\n    --repository \"https://github.com/example/my_library\" \\\n    --rustversion \"1.60\" \\\n    --version \"0.1.0\" \\\n    --website \"https://example.com/john-smith\"\n```\n\nor locally if you have cloned the repository:\n\n```shell\ncargo run -- manual --author \"John Smith\" \\\n    --build \"build.rs\" \\\n    --categories \"['category 1', 'category 2', 'category 3']\" \\\n    --description \"A Rust library for doing cool things\" \\\n    --documentation \"https://docs.rs/my_library\" \\\n    --edition \"2021\" \\\n    --email \"john.smith@example.com\" \\\n    --homepage \"https://my_library.rs\" \\\n    --keywords \"['rust', 'library', 'cool']\" \\\n    --license \"MIT\" \\\n    --name \"my_library\" \\\n    --output \"my_library\" \\\n    --readme \"README.md\" \\\n    --repository \"https://github.com/example/my_library\" \\\n    --rustversion \"1.60\" \\\n    --version \"0.1.0\" \\\n    --website \"https://example.com/john-smith\"\n```\n\n### Examples\n\nTo get started with `LibMake`, you can use the examples provided in the `examples` directory of the project.\n\nTo run the examples, clone the repository and run the following command in your terminal from the project root directory.\n\n| Example | Description | Command |\n|---------|-------------|---------|\n| `generate_from_args` | Generates a library template using the command-line interface. | `cargo run --example generate_from_args` |\n| `generate_from_config` | Generates a library template from a configuration file. | `cargo run --example generate_from_config` |\n| `generate_from_csv` | Generates a library template from a CSV file. | `cargo run --example generate_from_csv` |\n| `generate_from_ini` | Generates a library template from an INI file. | `cargo run --example generate_from_ini` |\n| `generate_from_json` | Generates a library template from a JSON file. | `cargo run --example generate_from_json` |\n| `generate_from_toml` | Generates a library template from a TOML file. | `cargo run --example generate_from_toml` |\n| `generate_from_yaml` | Generates a library template from a YAML file. | `cargo run --example generate_from_yaml` |\n\n## Semantic Versioning Policy\n\nFor transparency into our release cycle and in striving to maintain\nbackward compatibility, `libmake` follows [semantic versioning][07].\n\n## License\n\nThe project is licensed under the terms of both the MIT license and the\nApache License (Version 2.0).\n\n- [Apache License, Version 2.0][02]\n- [MIT license][03]\n\n## Contribution\n\nWe welcome all people who want to contribute. Please see the\n[contributing instructions][05] for more information.\n\nContributions in any form (issues, pull requests, etc.) to this project\nmust adhere to the [Rust's Code of Conduct][12].\n\nUnless you explicitly state otherwise, any contribution intentionally\nsubmitted for inclusion in the work by you, as defined in the\nApache-2.0 license, shall be dual licensed as above, without any\nadditional terms or conditions.\n\n## Acknowledgements\n\nA big thank you to all the awesome contributors of [libmake][06] for their help\nand support. A special thank you goes to the [Rust Reddit][15] community for\nproviding a lot of useful suggestions on how to improve this project.\n\n[00]: https://minifunctions.com/libmake \"Mini Functions\"\n[01]: https://libmake.com \"LibMake\"\n[02]: https://opensource.org/license/apache-2-0/ \"Apache License, Version 2.0\"\n[03]: http://opensource.org/licenses/MIT \"MIT license\"\n[04]: https://github.com/sebastienrousseau/libmake/issues \"Issues\"\n[05]: https://github.com/sebastienrousseau/libmake/blob/main/CONTRIBUTING.md \"Contributing\"\n[06]: https://github.com/sebastienrousseau/libmake/graphs/contributors \"Contributors\"\n[07]: http://semver.org/ \"Semantic Versioning\"\n[08]: https://crates.io/crates/libmake \"LibMake on crates.io\"\n[09]: https://docs.rs/libmake \"LibMake on docs.rs\"\n[10]: https://lib.rs/crates/libmake \"LibMake on lib.rs\"\n[11]: https://github.com/sebastienrousseau/libmake/actions \"GitHub Actions\"\n[12]: https://www.rust-lang.org/policies/code-of-conduct \"Rust's Code of Conduct\"\n[13]: https://www.rust-lang.org \"The Rust Programming Language\"\n[14]: https://codecov.io/gh/sebastienrousseau/libmake \"Codecov\"\n[15]: https://www.reddit.com/r/rust/ \"Rust Reddit\"\n\n[banner]: https://kura.pro/libmake/images/titles/title-libmake.svg \"LibMake Banner\"\n[codecov-badge]: https://img.shields.io/codecov/c/github/sebastienrousseau/libmake?style=for-the-badge\u0026token=Q9KJ6XXL67 \"Codecov Badge\"\n[crates-badge]: https://img.shields.io/crates/v/libmake.svg?style=for-the-badge \"Crates.io Badge\"\n[divider]: https://kura.pro/common/images/elements/divider.svg \"divider\"\n[docs-badge]: https://img.shields.io/docsrs/libmake.svg?style=for-the-badge \"Docs.rs Badge\"\n[libs-badge]: https://img.shields.io/badge/lib.rs-v0.2.6-orange.svg?style=for-the-badge \"Lib.rs Badge\"\n[license-badge]: https://img.shields.io/crates/l/libmake.svg?style=for-the-badge \"License Badge\"\n[made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge\u0026labelColor=c0282d\u0026logo=rust \"Made With Rust Badge\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsebastienrousseau%2Flibmake","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsebastienrousseau%2Flibmake","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsebastienrousseau%2Flibmake/lists"}