Skip to content

Commit 34ead1f

Browse files
committed
docs: update readme
1 parent d30cd82 commit 34ead1f

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
<img src="./.assets/christmas_ferris.png" width="164" align="center">
1+
<img src="./.assets/christmas_ferris.png" width="164">
22

3-
# 🎄 [Advent of Code](https://adventofcode.com/)
3+
# 🎄 Advent of Code {year}
44

5-
Cross-platform template for solving Advent of Code in Rust.
5+
Solutions for [Advent of Code](https://adventofcode.com/) in [Rust](https://www.rust-lang.org/).
66

77
<!--- advent_readme_stars table --->
88

9-
## Setup
9+
---
10+
11+
## Template setup
12+
13+
This template supports all major OS (macOS, Linux, Windows).
1014

1115
### Create your repository
1216

@@ -26,7 +30,7 @@ Cross-platform template for solving Advent of Code in Rust.
2630

2731
## Usage
2832

29-
### Setup new day
33+
### Scaffold a day
3034

3135
```sh
3236
# example: `cargo scaffold 1`
@@ -46,7 +50,7 @@ Every [solution](https://github.com/fspoettel/advent-of-code-rust/blob/master/sr
4650

4751
When editing a solution, `rust-analyzer` will display buttons for these actions above the unit tests.
4852

49-
### Download inputs for a day
53+
### Download input for a day
5054

5155
> **Note**
5256
> This command requires [installing the aoc-cli crate](#download-inputs-via-aoc-cli).
@@ -90,7 +94,7 @@ cargo day <day>
9094

9195
Displayed _timings_ show the raw execution time of your solution without overhead (e.g. file reads).
9296

93-
### Run solutions for all days
97+
### Run all solutions
9498

9599
```sh
96100
cargo all
@@ -135,7 +139,7 @@ cargo clippy
135139

136140
## Optional template features
137141

138-
### Download inputs via aoc-cli
142+
### Download puzzle inputs via aoc-cli
139143

140144
1. Install [`aoc-cli`](https://github.com/scarvalhojr/aoc-cli/) via cargo: `cargo install aoc-cli`.
141145
2. Create an `.adventofcode.session` file in your home directory and paste your session cookie into it. To get this, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in your Cookies under the Application or Storage tab, and copy out the `session` cookie value.
@@ -145,17 +149,17 @@ Once installed, you can use the [download command](#download-inputs-for-a-day).
145149
> **Note**
146150
> 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.
147151
148-
### CI: enable clippy lints
152+
### Enable clippy lints in CI
149153

150154
Uncomment the `clippy` job in the `ci.yml` workflow to enable clippy checks in CI.
151155

152-
### Readme progress tracker
156+
### Automatically track ⭐️ progress in readme
153157

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

156160
To enable it, complete the following steps:
157161

158-
#### 1. Create private leaderboard
162+
#### 1. Create a private leaderboard
159163

160164
Go to the leaderboard page of the year you want to track and click _Private Leaderboard_. If you have not created a leaderboard yet, create one by clicking _Create It_. Your leaderboard should be accessible under `https://adventofcode.com/{year}/leaderboard/private/view/{aoc_user_id}`.
161165

0 commit comments

Comments
 (0)