Skip to content

Commit 4c42321

Browse files
committed
docs: improve skimmability
1 parent f8a1368 commit 4c42321

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ Solutions for [Advent of Code](https://adventofcode.com/) in [Rust](https://www.
1414

1515
This template supports all major OS (macOS, Linux, Windows).
1616

17-
### Create your repository 📝
17+
### 📝 Create your repository
1818

1919
1. Open [the template repository](https://github.com/fspoettel/advent-of-code-rust) on Github.
2020
2. Click [Use this template](https://github.com/fspoettel/advent-of-code-rust/generate) and create your repository.
2121
3. Clone your repository to your computer.
2222
4. If you are solving a previous year's advent of code, change the `AOC_YEAR` variable in `.cargo/config.toml` to reflect the year you are solving.
2323

24-
### Setup rust 💻
24+
### 💻 Setup rust
2525

2626
1. Install the [Rust toolchain](https://www.rust-lang.org/tools/install).
2727
2. (recommended) Install the [rust-analyzer](https://rust-analyzer.github.io/manual.html) extension for your code editor.
@@ -33,7 +33,7 @@ This template supports all major OS (macOS, Linux, Windows).
3333

3434
## Usage
3535

36-
### Scaffold a day
36+
### ➡️ Scaffold a day
3737

3838
```sh
3939
# example: `cargo scaffold 1`
@@ -54,12 +54,12 @@ Every [solution](https://github.com/fspoettel/advent-of-code-rust/blob/main/src/
5454
> [!TIP]
5555
> 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`.
5656
57-
### Download input & description for a day
57+
### ➡️ Download input for a day
5858

5959
> [!IMPORTANT]
6060
> This requires [installing the aoc-cli crate](#configure-aoc-cli-integration).
6161
62-
You can automatically download puzzle inputs and description by either appending the `--download` flag to `scaffold` (e.g. `cargo scaffold 4 --download`) or with the separate `download` command:
62+
You can automatically download puzzle input and description by either appending the `--download` flag to `scaffold` (e.g. `cargo scaffold 4 --download`) or with the separate `download` command:
6363

6464
```sh
6565
# example: `cargo download 1`
@@ -74,7 +74,7 @@ cargo download <day>
7474
# 🎄 Successfully wrote puzzle to "data/puzzles/01.md".
7575
```
7676

77-
### Run solutions for a day
77+
### ➡️ Run solutions for a day
7878

7979
```sh
8080
# example: `cargo solve 01`
@@ -100,7 +100,7 @@ For example, running a benchmarked, optimized execution of day 1 would look like
100100
101101
In order to submit part of a solution for checking, append the `--submit <part>` option to the `solve` command.
102102

103-
### Run all solutions
103+
### ➡️ Run all solutions
104104

105105
```sh
106106
cargo all
@@ -124,27 +124,27 @@ The template can output a table with solution times to your readme. In order to
124124

125125
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.
126126

127-
### Run all tests
127+
### ➡️ Run all tests
128128

129129
```sh
130130
cargo test
131131
```
132132

133133
To run tests for a specific day, append `--bin <day>`, e.g. `cargo test --bin 01`. You can further scope it down to a specific part, e.g. `cargo test --bin 01 part_one`.
134134

135-
### Format code
135+
### ➡️ Format code
136136

137137
```sh
138138
cargo fmt
139139
```
140140

141-
### Lint code
141+
### ➡️ Lint code
142142

143143
```sh
144144
cargo clippy
145145
```
146146

147-
### Read puzzle description in terminal
147+
### ➡️ Read puzzle description
148148

149149
> [!IMPORTANT]
150150
> This command requires [installing the aoc-cli crate](#configure-aoc-cli-integration).
@@ -159,7 +159,7 @@ cargo read <day>
159159
# ...the input...
160160
```
161161

162-
### Scaffold, download and read in one go
162+
### ➡️ Scaffold, download & read the current aoc day
163163

164164
> [!IMPORTANT]
165165
> This command requires [installing the aoc-cli crate](#configure-aoc-cli-integration).

0 commit comments

Comments
 (0)