Add README file

This commit is contained in:
Zoé Cassiopée Gauthier 2021-12-06 14:34:46 -05:00
parent 258c6aff24
commit 15cf19e24a

21
README.md Normal file
View File

@ -0,0 +1,21 @@
[![Unit tests](https://github.com/zoeisnowooze/advent2021/actions/workflows/ci.yml/badge.svg)](https://github.com/zoeisnowooze/advent2021/actions/workflows/ci.yml)
Solvers for the [2021 Advent of Code](https://adventofcode.com/2021/) festive programming puzzles.
## Installation
Install the Rust toolchain to build the daily problem solvers. Go to the [rustup](https://rustup.rs/) page and follow the instructions.
## Usage
You can run the unit tests for all the daily problems
```bash
cargo test
```
and then run individual solvers by specifying the name of the daily binary, for example
```bash
cargo run --bin day6
```