refactor: better explain scaffolding

This commit is contained in:
2025-12-03 15:16:25 +01:00
parent b39b8c885b
commit 8be18b6b38

View File

@@ -52,7 +52,9 @@ When running a solution, the CLI (`cmd/aoc/main.go`) looks up the appropriate ru
make 2020D1 make 2020D1
``` ```
This will create the following files: If the `ADVENTOFCODE_SESSION` environment variable is set with your Advent of Code session cookie, the input will be downloaded from the AOC website right into the corresponding `internal/data` directory, else it will create an empty `input.txt` file.
Then, it will create the following files:
```bash ```bash
internal/2020/DayOne/code.go internal/2020/DayOne/code.go
@@ -60,8 +62,6 @@ internal/2020/DayOne/code_test.go
internal/data/2020/DayOne/input.txt internal/data/2020/DayOne/input.txt
``` ```
If the `ADVENTOFCODE_SESSION` environment variable is set with your Advent of Code session cookie, the input will be downloaded from the AOC website right into the corresponding `internal/data` directory, else it will create an empty `input.txt` file.
### Handling string answers ### Handling string answers
Occasionally, a puzzle requires a string as the answer. However, my solution framework expects PartOne/PartTwo functions to return integers. Occasionally, a puzzle requires a string as the answer. However, my solution framework expects PartOne/PartTwo functions to return integers.