Skip to content

Commit

Permalink
fix missing links
Browse files Browse the repository at this point in the history
and some minor rewording. I'm just being picky at this point.
  • Loading branch information
drmason13 committed May 8, 2021
1 parent f610c74 commit 68312e1
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,15 @@ This is [advent_of_code_traits][github], a minimal, flexible framework for imple

It takes a trait-based approach using const-generics.

## Experimental

This is already serviceable, but there will be frequent breaking changes as the traits are improved and refined.
The plan is to release a stable version in time for December 2021.


## Usage

Please see also the [examples].
Please see also the [examples](./examples/).

Implement traits with your solutions to each Day of Advent of Code.

Expand Down Expand Up @@ -87,9 +93,9 @@ is required in order to disambiguate which day's Solution we are running.
Because the `Solution` and `ParseInput` traits are generic over `const Day: u32` you are free to implement them many times for the same struct.
The compiler will only yell at you if you implement them for the same Day twice (as it should!).

`Day1` is used in the examples (because it looks awesome in my humble opinion).
`Day1` is used in the examples (because it looks awesome in my humble opinion). It is simply `1_u32`.

It is literally just `1_u32`. `advent_of_code_traits::days` looks like this:
`advent_of_code_traits::days` looks like this:

```
mod days {
Expand All @@ -114,9 +120,9 @@ Thank you Gobanos! :)

## Contributing

Contributions are welcome, please see [CONTRIBUTING.md]
Contributions are welcome, please see [CONTRIBUTING](./CONTRIBUTING.md)

Please also see [ARCHITECTURE.md] for a guided tour of sorts of the code base.
Please also see [ARCHITECTURE](./ARCHITECTURE.md) for a guided tour of sorts of the code base.

<br>

Expand Down

0 comments on commit 68312e1

Please sign in to comment.