From 5b91c3815c8ff705456ae8ce0602d7fe3a01cbfd Mon Sep 17 00:00:00 2001 From: Nathan McCarty Date: Mon, 6 Jan 2025 08:57:49 -0500 Subject: [PATCH] doc: Initial readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..87ea2a4 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Advent + +The goal of this project is to get all 500 currently available stars in the form of one single idris application, and thoroughly document the results as literate idris files. + +# Index of non-day modules + +- [Runner](src/Runner.md) + + Provides data structures for structuring the division of the project into years, days, and parts. +- [Util](src/Util.md) + + Provides extensions of the functionality of the standard library and external libraries. Extensions to the standard library are in the base of this module. + + - [Util.Eff](src/Util/Eff.md) + + Extend the functionality of the effects included in the [eff](https://github.com/stefan-hoeck/idris2-eff/) library + +# Index of years and days + +- 2015 + - [Day 1](src/Years/Y2015/Day1.md) + - [Day 2](src/Years/Y2015/Day2.md)