fix: update README with correct filetree

This commit is contained in:
Matej Janezic 2023-11-23 23:31:08 +01:00
parent 000004005f
commit 000004100d
Signed by: janezicmatej
GPG Key ID: 4298E230ED37B2C0
3 changed files with 8 additions and 7 deletions

6
Cargo.lock generated
View File

@ -19,7 +19,7 @@ checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe"
[[package]]
name = "aoc"
version = "40.0.0"
version = "41.0.0"
dependencies = [
"itertools",
]
@ -105,7 +105,7 @@ checksum = "03d8c417d7a8cb362e0c37e5d815f5eb7c37f79ff93707329d5a194e42e54ca0"
[[package]]
name = "download"
version = "40.0.0"
version = "41.0.0"
dependencies = [
"dotenvy",
"pico-args",
@ -643,7 +643,7 @@ checksum = "7b4b9743ed687d4b4bcedf9ff5eaa7398495ae14e61cba0a295704edbc7decde"
[[package]]
name = "scaffold"
version = "40.0.0"
version = "41.0.0"
dependencies = [
"dotenvy",
"pico-args",

View File

@ -19,7 +19,7 @@ members = ["utils/download", "utils/scaffold"]
[workspace.package]
description = "template for advent of code"
readme = "README.md"
version = "40.0.0"
version = "41.0.0"
edition = "2021"
license = "MIT"
authors = ["Matej Janežič <janezic.mj@gmail.com>"]

View File

@ -5,15 +5,16 @@
## Project overview
### Project structure
- `data/` :
- `examples/`: example files go here; you can push this as test are run in ci
- `inputs/`: this directory is gitignored, input files go here
- `src/` :
- `bin/`:
- `<day>.rs`: solution files
- `inputs/`: this directory is gitignored, input files go here
- `examples/`: example files go here; you can push this as test are run in ci
- `utils/`: utils files go here
- `lib.rs`: contains framework code
- `.env.example`: example dotenv file
- `utils/`: binary packages with convenience scripts structured using cargo workspaces
- `.env.example`: example dotenv file
### Cli
- `cargo scaffold <day>`: prepare solution files for `day`