Welcome

August is a task-based build system with a strong focus on parallelism. It is written in Rust, a language known for its stability and performance and relies on custom syntax to describe the build process.

August's name is derived from the name of a certain character, from a certain game, whose name is derived from the name of a certain German aircraft carrier.¹

Quick Links

Start Here Learn how to use August to write build scripts using Rust and Cargo as an example use case.

CLI Usage A guide to all of the commands in the August CLI tool

Impl Docs All about the design of August

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
• chumsky: My new favourite parser combinator library (also 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
• dircpy: Recursive directory copying for August's fs::copy by @woelper
• owo-colors: Vibrant colouring for displaying CLI execution by @jam1garner
• thiserror: Helper for implementing std::error::Error by @dtolnay
• which: Magic that makes August's exec work better by @harryfei

Show off in your repo

If you use August in your project, you can add this badge to your README:

[![Built with August](https://img.shields.io/badge/built%20with-august-blueviolet)](https://github.com/ScratchCat458/august-build)

---

1. For those who are curious... ↩