From 56341aca1afd6ebc0593c94c60c64008b3708b62 Mon Sep 17 00:00:00 2001 From: Tom Van Eyck Date: Mon, 4 Dec 2023 12:51:38 +0100 Subject: [PATCH] Update documentation --- README.md | 42 ++++++++++++++++++++++++++---------------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 2a9fd71..81e882c 100644 --- a/README.md +++ b/README.md @@ -74,22 +74,6 @@ cargo download # 🎄 Successfully wrote puzzle to "data/puzzles/01.md". ``` -### Scaffold and download in one go - -This command runs `cargo scaffold` and `cargo download` for the current day. - -```sh -cargo today - -# output: -# [INFO aoc] 🎄 aoc-cli - Advent of Code command-line tool -# [INFO aoc_client] 🎅 Saved puzzle to 'data/puzzles/01.md' -# [INFO aoc_client] 🎅 Saved input to 'data/inputs/01.txt' -# --- -# 🎄 Successfully wrote input to "data/inputs/01.txt". -# 🎄 Successfully wrote puzzle to "data/puzzles/01.md". -``` - ### Run solutions for a day ```sh @@ -175,6 +159,32 @@ cargo read # ...the input... ``` +### Scaffold, download and read in one go + +This command runs `cargo scaffold`, `cargo download` and `cargo read` for the current day. + +```sh +# example: `cargo today` on December 1st +cargo today + +# output: +# Created module file "src/bin/01.rs" +# Created empty input file "data/inputs/01.txt" +# Created empty example file "data/examples/01.txt" +# --- +# 🎄 Type `cargo solve 01` to run your solution. +# [INFO aoc] 🎄 aoc-cli - Advent of Code command-line tool +# [INFO aoc_client] 🎅 Saved puzzle to 'data/puzzles/01.md' +# [INFO aoc_client] 🎅 Saved input to 'data/inputs/01.txt' +# --- +# 🎄 Successfully wrote input to "data/inputs/01.txt". +# 🎄 Successfully wrote puzzle to "data/puzzles/01.md". +# +# Loaded session cookie from "/Users//.adventofcode.session". +# Fetching puzzle for day 1, 2022... +# ...the input... +``` + ## Optional template features ### Configure aoc-cli integration