You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,14 +49,11 @@ cargo scaffold <day>
49
49
50
50
Individual solutions live in the `./src/bin/` directory as separate binaries. _Inputs_ and _examples_ live in the the `./data` directory.
51
51
52
-
Every [solution](https://github.com/fspoettel/advent-of-code-rust/blob/main/src/template/commands/scaffold.rs#L9-L35) has _tests_ referencing its _example_ file in `./data/examples`. Use these tests to develop and debug your solutions against the example input.
52
+
Every [solution](https://github.com/fspoettel/advent-of-code-rust/blob/main/src/template/commands/scaffold.rs#L9-L35) has _tests_ referencing its _example_ file in `./data/examples`. Use these tests to develop and debug your solutions against the example input. In VS Code, `rust-analyzer` will display buttons for running / debugging these unit tests above the unit test blocks.
53
53
54
54
> [!TIP]
55
55
> If a day has different example inputs for both parts, you can use the `read_file_part()` helper in your tests instead of `read_file()`. For example, if this applies to day 1, you can create a second example file `01-2.txt` and invoke the helper like `let result = part_two(&advent_of_code::template::read_file_part("examples", DAY, 2));` to read it in `test_part_two`.
56
56
57
-
> [!TIP]
58
-
> when editing a solution, `rust-analyzer` will display buttons for running / debugging unit tests above the unit test blocks.
59
-
60
57
### Download input & description for a day
61
58
62
59
> [!IMPORTANT]
@@ -99,7 +96,7 @@ For example, running a benchmarked, optimized execution of day 1 would look like
99
96
#### Submitting solutions
100
97
101
98
> [!IMPORTANT]
102
-
> This command requires [installing the aoc-cli crate](#configure-aoc-cli-integration).
99
+
> This requires [installing the aoc-cli crate](#configure-aoc-cli-integration).
103
100
104
101
In order to submit part of a solution for checking, append the `--submit <part>` option to the `solve` command.
105
102
@@ -123,7 +120,7 @@ This runs all solutions sequentially and prints output to the command-line. Same
123
120
124
121
#### Update readme benchmarks
125
122
126
-
The template can output a table with solution times to your readme. In order to generate a benchmarking table, run `cargo all --release --time`. If everything goes well, the command will output "_Successfully updated README with benchmarks._" after the execution finishes and the readme will be updated.
123
+
The template can output a table with solution times to your readme. In order to generate a benchmarking table, run `cargo time`. If everything goes well, the command will output "_Successfully updated README with benchmarks._" after the execution finishes and the readme will be updated.
127
124
128
125
Please note that these are not "scientific" benchmarks, understand them as a fun approximation. 😉 Timings, especially in the microseconds range, might change a bit between invocations.
0 commit comments