# August

[![crates.io](https://img.shields.io/crates/v/august-build)](https://crates.io/crates/august-build)
![Workflow Status](https://github.com/ScratchCat458/august-build/actions/workflows/rust.yml/badge.svg)
![License](https://img.shields.io/crates/l/august-build)

![August Logo](https://raw.githubusercontent.com/ScratchCat458/august-build/master/docs/images/August%20Build.svg) 

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.

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)
```markdown
[![Built with August](https://img.shields.io/badge/built%20with-august-blueviolet)](https://github.com/ScratchCat458/august-build)
```