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.
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
August's user documentation can be found at https://august-build.web.app. Internal docs can be found on docs.rs though everything is mostly undocumented.
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
- clap_complete: Generator for command line autocompletions, see august completions
- comfy-table: Beautiful table generation for august info and august inspect 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
- tracing and tracing-subscriber: Nice app-level diagnostics by the @tokio-rs team
If you use August in your project, you can add this badge to your README:
markdown
[](https://github.com/ScratchCat458/august-build)