Skip to content

Commit 3ac3026

Browse files
committed
docs: typos
1 parent ffc7cdb commit 3ac3026

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Solutions for [Advent of Code](https://adventofcode.com/) in [Rust](https://www.
1212

1313
This template supports all major OS (macOS, Linux, Windows).
1414

15-
### Create your repository
15+
### Create your repository 📝
1616

1717
1. Open [the template repository](https://github.com/fspoettel/advent-of-code-rust) on Github.
18-
2. Click `Use this template` and create your repository.
18+
2. Click [Use this template](https://github.com/fspoettel/advent-of-code-rust/generate) and create your repository.
1919
3. Clone your repository to your computer.
2020

21-
### Setup rust
21+
### Setup rust 💻
2222

2323
1. Install the [Rust toolchain](https://www.rust-lang.org/tools/install).
2424
2. (recommended) Install the [rust-analyzer](https://rust-analyzer.github.io/manual.html) extension for your code editor.
@@ -46,7 +46,7 @@ cargo scaffold <day>
4646

4747
Individual solutions live in the `./src/bin/` directory as separate binaries.
4848

49-
Every [solution](https://github.com/fspoettel/advent-of-code-rust/blob/main/src/bin/scaffold.rs#L11-L41) has _unit tests_ referencing its _example_ file. Use these unit tests to develop and debug your solution against example inputs. For some puzzles, it might be easier to forgo the example file and hardcode inputs into the tests.
49+
Every [solution](https://github.com/fspoettel/advent-of-code-rust/blob/main/src/bin/scaffold.rs#L11-L41) has _unit tests_ referencing its _example_ file. Use these unit tests to develop and debug your solution against the example input. For some puzzles, it might be easier to forgo the example file and hardcode inputs into the tests.
5050

5151
When editing a solution, `rust-analyzer` will display buttons for running / debugging unit tests above the unit test blocks.
5252

@@ -119,7 +119,7 @@ cargo all
119119

120120
_Total timing_ is computed from individual solution _timings_ and excludes as much overhead as possible.
121121

122-
### Run all solutions against example input
122+
### Run all solutions against the example input
123123

124124
```sh
125125
cargo test
@@ -150,7 +150,7 @@ Once installed, you can use the [download command](#download-input-for-a-day).
150150

151151
Uncomment the `clippy` job in the `ci.yml` workflow to enable clippy checks in CI.
152152

153-
### Automatically track ⭐️ progress in readme
153+
### Automatically track ⭐️ progress in the readme
154154

155155
This template includes [a Github action](https://github.com/k2bd/advent-readme-stars) that automatically updates the readme with your advent of code progress.
156156

@@ -171,10 +171,10 @@ Go to the _Secrets_ tab in your repository settings and create the following sec
171171

172172
### Use VS Code to debug your code
173173

174-
1. Install [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) and [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb).
175-
2. Set breakpoints in your code. [^3]
176-
3. Click _Debug_ next to the unit test or the _main_ function. [^4]
177-
4. The debugger will halt your program at the specific line and allow you to inspect the local stack. [^5]
174+
1. Install [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) and [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb).
175+
2. Set breakpoints in your code. [^3]
176+
3. Click _Debug_ next to the unit test or the _main_ function. [^4]
177+
4. The debugger will halt your program at the specific line and allow you to inspect the local stack. [^5]
178178

179179
## Useful crates
180180

@@ -188,12 +188,17 @@ Do you have aoc-specific crate recommendations? [Share them!](https://github.com
188188

189189
## Common pitfalls
190190

191-
* **Integer overflows:** This template uses 32-bit integers by default because it is generally faster - for example when packed in large arrays or structs - than using 64-bit integers everywhere. For some problems, solutions for real input might exceed 32-bit integer space. While this is checked and panics in `debug` mode, integers [wrap](https://doc.rust-lang.org/book/ch03-02-data-types.html#integer-overflow) in `release` mode, leading to wrong output when running your solution.
191+
- **Integer overflows:** This template uses 32-bit integers by default because it is generally faster - for example when packed in large arrays or structs - than using 64-bit integers everywhere. For some problems, solutions for real input might exceed 32-bit integer space. While this is checked and panics in `debug` mode, integers [wrap](https://doc.rust-lang.org/book/ch03-02-data-types.html#integer-overflow) in `release` mode, leading to wrong output when running your solution.
192192

193193
## Footnotes
194194

195195
[^1]: The session cookie might expire after a while (~1 month) which causes the downloads to fail. To fix this issue, refresh the `.adventofcode.session` file.
196196
[^2]: The session cookie might expire after a while (~1 month) which causes the automated workflow to fail. To fix this issue, refresh the AOC_SESSION secret.
197-
[^3]: <img src="https://user-images.githubusercontent.com/1682504/198838369-453dc22c-c645-4803-afe0-fc50d5a3f00c.png" alt="Set a breakpoint" width="450" />
198-
[^4]: <img alt="Run debugger" src="https://user-images.githubusercontent.com/1682504/198838372-c89369f6-0d05-462e-a4c7-8cd97b0912e6.png" width="450" />
199-
[^5]: <img alt="Inspect debugger state" src="https://user-images.githubusercontent.com/1682504/198838373-36df6996-23bf-4757-9335-0bc4c1db0276.png" width="450" />
197+
[^3]:
198+
<img src="https://user-images.githubusercontent.com/1682504/198838369-453dc22c-c645-4803-afe0-fc50d5a3f00c.png" alt="Set a breakpoint" width="450" />
199+
200+
[^4]:
201+
<img alt="Run debugger" src="https://user-images.githubusercontent.com/1682504/198838372-c89369f6-0d05-462e-a4c7-8cd97b0912e6.png" width="450" />
202+
203+
[^5]:
204+
<img alt="Inspect debugger state" src="https://user-images.githubusercontent.com/1682504/198838373-36df6996-23bf-4757-9335-0bc4c1db0276.png" width="450" />

0 commit comments

Comments
 (0)