From c84605f8f0d15fa8fca0500c77587cc5af347944 Mon Sep 17 00:00:00 2001 From: Michael Raitza Date: Fri, 16 Apr 2021 20:24:56 +0200 Subject: [PATCH] Extend README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ffa9fd0..894a540 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,6 @@ export AUTHOR="My Name" ``` "aoc2020.dayN" aoc-init ``` - -* See `aoc2020.day1` for an example. If a solution is worth an explanation, it should go to the description in the docs. +* See `aoc2020.day1` for an example. If a solution is worth an explanation, it should go to the description in the docs in `dayN-docs.factor`. * By convention, the `MAIN:` function solves the exact task given, while the core function solves the core problem (no input parsing, no output formatting). Sometimes it solves a more generalized problem; sometimes it solves only a specific subset of the problem (which happens in AoC problems, when an input exploit is needed). +* `dayN-tests.factor` should contain the test cases for the puzzle. It may be a good idea to start with the model problem and solution for that day. Later, you can incorporate your personal dataset, which is kept in `datasets/aoc2020/dayN.txt`.