# tournaments
Rust library for running tournaments. Be aware it's early days so the API is likely to change.
[](https://crates.io/crates/tournaments)
[](https://docs.rs/tournaments)
[](https://choosealicense.com/licenses/mit/)
[](https://crates.io/crates/tournaments)
## Use
### Installation
tournaments is [hosted on crates.io](https://crates.io/crates/tournaments). Install with `cargo add tournaments`.
### Documentation
Documentation is [hosted on doc.rs](https://docs.rs/tournaments).
## Development
### Prerequisites
1. [Python](https://www.python.org/downloads/)
2. [Rust](https://www.rust-lang.org/tools/install)
### Setup
1. `pip install -r requirements.txt`
2. `pre-commit install`
3. `rustup update`
### Commands
- Build and run: `cargo run`
- Just build: `cargo build`
- Run the unit tests: `cargo test`
- Build the documentation: `cargo doc`