Add Readme

This commit is contained in:
Alexander Gehrke 2021-12-02 23:52:49 +01:00
parent 67f1187525
commit 1c2a4c6e59

21
README.md Normal file
View file

@ -0,0 +1,21 @@
# Advent of Code 2021
See also [Advent of Code homepage](https://adventofcode.com/2021)
## Running
To call the main method via `sbt`, use `sbt run <input_dir> <day> [sample]
- `<input_dir>` should be a directory containing files named `day1.txt`, `day2.txt`, ...
- `<day>` is given as a single integer
- optionally, `[sample]` is the number of a sample input to use (place in the input directory)
Without a sample input number, the solution for the given day `X` will be run with `<input dir>/day<X>.txt` as input. If a sample input number `S` is given, `<input dir>/day<X>-sample<S>.txt` is used instead.
Examples:
```
# Run day 1 with day1.txt
sbt "run input/2021 1"
# Run day 2 with day2-sample1.txt
sbt "run input/2021 2 1"
```