August

crates.io Workflow Status dependency status License

August Logo

August is a build system much like others of the task-based genre. It uses a custom syntax for configuring builds and can import other files for the purpose of modularity.

Installation

The recommended installation method is via Cargo: sh cargo install august-build To install from source, clone the repo, run the following command and copy out the binary: sh cargo build --release

Documentation

Writing the getting started documentation is still in progress, but most of the implementation details have been written up. To view the docs locally (for now until I get some proper hosting), you will need pip: sh pip install mkdocs-material mkdocs serve

Brilliant Crates

August is only made possible thanks to the efforts of many others. Here they all are: - ariadne: Beautiful parser error handling by @zesterer - clap: Derive-based command-line argument parser - comfy-table: Beautiful table generation for august info by @Nukesor - dirs: Used exclusively for finding the home directory - owo-colors: Vibrant colouring for displaying CLI execution by @jam1garner - run-script: Used so I don't have to think about argument separation in the exec command by @sagiegurari - walkdir: Directory recursion for module resolution by @BurntSushi

If you use August in your project, you can add this badge to your README: Built with August markdown [![Built with August](https://img.shields.io/badge/built%20with-august-blueviolet)](https://github.com/ScratchCat458/august-build)