From 2b80c9168a03cb4f7e7309f6356fba3c44900ecd Mon Sep 17 00:00:00 2001
From: Baipyrus <simon.waltemathe@gmail.com>
Date: Sun, 10 Dec 2023 16:59:11 +0100
Subject: [PATCH] basic README to explain repo

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..59df422
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Advent of Code 2023
+
+## About
+
+This repository stores my solutions to the daily challenges of [Advent of Code Calendar 2023](https://adventofcode.com/2023/).
+
+## Execution
+
+Any of the scripts can be executed directly using [NodeJS](https://nodejs.org/en/download/).
+
+**Example:**
+
+```bash
+cd Day01/
+node Part1.js
+```
+
+## File explanation
+
+A single challenge consists of 3 files:
+
+- `input.txt`: My input data, as provided by AoC.
+- `Part1.js`: My solution to part 1 of the challenge.
+- `Part2.js`: My solution to part 2 of the challenge.
+
+Other special files:
+
+- [`template.js`](template.js): A template file to use when initializing a new challenge.
+- `sample.js`: Example or test code; Ignored by git (see [.gitignore](.gitignore)).