# August
[](https://crates.io/crates/august-build)



August is a task-based build system with a strong focus on parallelism.
## Installation
The recommended installation method is via Cargo:
```sh
cargo install august-build
```
To install from source:
```sh
git clone https://github.com/ScratchCat458/august-build
cd august-build
cargo install --path .
```
## Documentation
August's user documentation can be found at [https://august-build.web.app](https://august-build.web.app).
Internal docs can be found on [docs.rs](https://docs.rs/august-build) though everything is mostly undocumented.
## Brilliant Crates
August is only made possible thanks to the efforts of many others.
Here they all are:
- [`ariadne`](https://github.com/zesterer/ariadne): Beautiful parser error handling by [@zesterer](https://github.com/zesterer)
- [`chumsky`](https://github.com/zesterer/chumsky): My new favourite parser combinator library (also by [@zesterer](https://github.com/zesterer))
- [`clap`](https://github.com/clap-rs/clap): Derive-based command-line argument parser
- [`clap_complete`](https://github.com/clap-rs/clap/tree/master/clap_complete): Generator for command line autocompletions, see `august completions`
- [`comfy-table`](https://github.com/nukesor/comfy-table): Beautiful table generation for `august info` and `august inspect` by [@Nukesor](https://github.com/nukesor)
- [`crossbeam-utils`](https://github.com/crossbeam-rs/crossbeam): Makes my spin blocking implementation less bad
- [`dircpy`](https://github.com/woelper/dircpy/): Recursive directory copying for August's `fs::copy` by [@woelper](https://github.com/woelper/)
- [`owo-colors`](https://github.com/jam1garner/owo-colors): Vibrant colouring for displaying CLI execution by [@jam1garner](https://github.com/jam1garner)
- [`thiserror`](https://github.com/dtolnay/thiserror): Helper for implementing `std::error::Error` by [@dtolnay](https://github.com/dtolnay)
- [`which`](https://github.com/harryfei/which-rs): Magic that makes August's `exec` work better by [@harryfei](https://github.com/harryfei/which-rs)
If you use August in your project, you can add this badge to your README: [](https://github.com/ScratchCat458/august-build)
```markdown
[](https://github.com/ScratchCat458/august-build)
```