Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
codingzorro committed Jan 14, 2024
1 parent 2fb6db2 commit 0b8654f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ transformation to one data structure.

## Usage

Just clone this repository and do whatever you want as long as it is legal and
does not harm anybody or anything.
Take a look at the `doc` directory for a day-by-day log.

## License

Expand Down
6 changes: 5 additions & 1 deletion doc/day01.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,15 @@ The calibration is a two-digit number "encrypted" in each line:
* extract all digits contained in the line: 1, 3 and 5 in this case
* take the first and the last one to get the calibration: 15 in this case

### Write the tests
### Step 1: Write the tests
It is clear that we need at least two functions:
* `(decode "a1b2c3d4e5f")` shall return `[1 3 5]`
* `(to-int [1 3 5])` shall return `15`

The unit tests for these functions are tagged in this repository as
[morning-01-red](https://github.com/codingzorro/advent2023/tree/morning-01-red).
Note that they fail; i.e, they are "red" according to the TDD terminology.

### Step 2: Go from "green" to "red"
Tag [morning-01-green](https://github.com/codingzorro/advent2023/releases/tag/morning-01-green)
implements the functions needed to pass the existing tests

0 comments on commit 0b8654f

Please sign in to comment.