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
+14-17
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ Tip: when editing a solution, `rust-analyzer` will display buttons for running /
56
56
### Download input & description for a day
57
57
58
58
> **Note**
59
-
> This command requires [installing the aoc-cli crate](#download-puzzle-inputs-via-aoc-cli).
59
+
> This command requires [installing the aoc-cli crate](#configure-aoc-cli-integration).
60
60
61
61
```sh
62
62
# example: `cargo download 1`
@@ -93,7 +93,7 @@ For example, running a benchmarked, optimized execution of day 1 would look like
93
93
#### Submitting solutions
94
94
95
95
> **Note**
96
-
> This requires [installing the aoc-cli crate](#download-puzzle-inputs-via-aoc-cli).
96
+
> This command requires [installing the aoc-cli crate](#configure-aoc-cli-integration).
97
97
98
98
In order to submit part of a solution for checking, append the `--submit <part>` option to the `solve` command.
99
99
@@ -140,19 +140,11 @@ cargo fmt
140
140
```sh
141
141
cargo clippy
142
142
```
143
-
## Optional template features
144
-
145
-
### Download puzzle inputs via aoc-cli
146
-
147
-
1. Install [`aoc-cli`](https://github.com/scarvalhojr/aoc-cli/) via cargo: `cargo install aoc-cli --version 0.12.0`
148
-
2. Create an `.adventofcode.session` file in your home directory and paste your session cookie. To get this, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in _Cookies_ under the _Application_ or _Storage_ tab, and copy out the `session` cookie value. [^1]
149
-
150
-
Once installed, you can use the [download command](#download-input--description-for-a-day).
151
143
152
144
### Read puzzle description in terminal
153
145
154
146
> **Note**
155
-
> This command requires [installing the aoc-cli crate](#download-puzzle-inputs-via-aoc-cli).
147
+
> This command requires [installing the aoc-cli crate](#configure-aoc-cli-integration).
156
148
157
149
```sh
158
150
# example: `cargo read 1`
@@ -164,13 +156,14 @@ cargo read <day>
164
156
# ...the input...
165
157
```
166
158
167
-
### Check code formatting in CI
159
+
##Optional template features
168
160
169
-
Uncomment the `format` job in the `ci.yml` workflow to enable fmt checks in CI.
161
+
### Configure aoc-cli integration
170
162
171
-
### Enable clippy lints in CI
163
+
1. Install [`aoc-cli`](https://github.com/scarvalhojr/aoc-cli/) via cargo: `cargo install aoc-cli --version 0.12.0`
164
+
2. Create an `.adventofcode.session` file in your home directory and paste your session cookie. To retrieve the session cookie, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in _Cookies_ under the _Application_ or _Storage_ tab, and copy out the `session` cookie value. [^1]
172
165
173
-
Uncomment the `clippy` job in the `ci.yml` workflow to enable clippy checks in CI.
166
+
Once installed, you can use the [download command](#download-input--description-for-a-day) and automatically submit solutions via the [`--submit` flag](#submitting-solutions).
174
167
175
168
### Automatically track ⭐️ progress in the readme
176
169
@@ -187,12 +180,16 @@ Go to the leaderboard page of the year you want to track and click _Private Lead
187
180
Go to the _Secrets_ tab in your repository settings and create the following secrets:
188
181
189
182
-`AOC_ENABLED`: This variable controls whether the workflow is enabled. Set it to `true` to enable the progress tracker.
190
-
-`AOC_USER_ID`: Go to [this page](https://adventofcode.com/settings) and copy your user id. It's the number behind the `#` symbol in the first name option. Example: `3031`
191
-
-`AOC_YEAR`: the year you want to track. Example: `2021`
183
+
-`AOC_USER_ID`: Go to [this page](https://adventofcode.com/settings) and copy your user id. It's the number behind the `#` symbol in the first name option. Example: `3031`.
184
+
-`AOC_YEAR`: the year you want to track. Example: `2021`.
192
185
-`AOC_SESSION`: an active session[^2] for the advent of code website. 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.
193
186
194
187
✨ You can now run this action manually via the _Run workflow_ button on the workflow page. If you want the workflow to run automatically, uncomment the `schedule` section in the `readme-stars.yml` workflow file or add a `push` trigger.
195
188
189
+
### Check code formatting / clippy lints in CI
190
+
191
+
Uncomment the respective sections in the `ci.yml` workflow.
192
+
196
193
### Use VS Code to debug your code
197
194
198
195
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).
0 commit comments