Add README.
This commit is contained in:
19
README.md
Normal file
19
README.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Advent of Code Implementations
|
||||||
|
|
||||||
|
Solutions to Advent of code problems written in OCaml
|
||||||
|
|
||||||
|
Copyright 2024, Matthew Gretton-Dann.
|
||||||
|
|
||||||
|
Licensed under the [Apache 2.0 license](./LICENSE).
|
||||||
|
|
||||||
|
## Build instructions
|
||||||
|
|
||||||
|
1. Install `ocaml`
|
||||||
|
2. Clone repository: `git clone https://gitea.gretton-dann.synology.me/mgrettondann/ocaml-aoc.git`
|
||||||
|
3. Enter directory: `cd ocaml-acc`
|
||||||
|
4. Set up switch: `opam switch create .`
|
||||||
|
5. Build with dune: `dune build`
|
||||||
|
|
||||||
|
## Executing tests
|
||||||
|
|
||||||
|
Tests are named as `bin/dayYYNN.exe`, where `YY` is the last two digits of the year, and `NN` is the day. For example `bin/day2401.exe` is the executable for 2024 day 1. All tests take a command line option containing the file name of puzzle input.
|
Reference in New Issue
Block a user