From 15cf19e24a8f37a80bf814d18a5bfaac9deb6044 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zo=C3=A9=20Cassiop=C3=A9e=20Gauthier?= Date: Mon, 6 Dec 2021 14:34:46 -0500 Subject: [PATCH] Add README file --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ba08f58 --- /dev/null +++ b/README.md @@ -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 +```