aboutsummaryrefslogtreecommitdiff
path: root/aoc2023-gleam/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'aoc2023-gleam/README.md')
-rw-r--r--aoc2023-gleam/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/aoc2023-gleam/README.md b/aoc2023-gleam/README.md
new file mode 100644
index 0000000..3f534e8
--- /dev/null
+++ b/aoc2023-gleam/README.md
@@ -0,0 +1,28 @@
+# aoc2023
+
+[![Package Version](https://img.shields.io/hexpm/v/aoc2023)](https://hex.pm/packages/aoc2023)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/aoc2023/)
+
+## Quick start
+
+```sh
+gleam run # Run the project
+gleam test # Run the tests
+gleam shell # Run an Erlang shell
+```
+
+## Installation
+
+If available on Hex this package can be added to your Gleam project:
+
+```sh
+gleam add aoc2023
+```
+
+and its documentation can be found at <https://hexdocs.pm/aoc2023>.
+
+## Use
+
+* Set up a solution: `gleam run -m adglent/day <n>`
+* Check against examples: `gleam test -- --modules=day<n>/day<n>_test`
+* Get final answer: `gleam run -m day<n>/solve <p>` \ No newline at end of file