feat: update template
This commit is contained in:
15
README.md
15
README.md
@@ -1,27 +1,26 @@
|
||||

|
||||
# Advent-of-Code 2016
|
||||
*This is a dumbed down version of [fspoettel/advent-of-code-rust](https://github.com/fspoettel/advent-of-code-rust) with some extra features*
|
||||
|
||||
## 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
|
||||
- `*.rs`: convenience scripts
|
||||
- `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
|
||||
- `main.rs`: contains framework code
|
||||
- `lib.rs`: library entrypoint, reusable code goes here
|
||||
- `template.rs`: contains template code
|
||||
- `utils/`: binary packages with convenience scripts structured using cargo workspaces
|
||||
- `.env.example`: example dotenv file
|
||||
|
||||
### Cli
|
||||
- `cargo scaffold <day>`: prepare solution files for `day`
|
||||
- `cargo download <day>`: download input file for `day`
|
||||
- `cargo solve <day>`: run solution against input for `day`
|
||||
- `cargo all`: alias for run; runs solutions for all days
|
||||
|
||||
*Run `cargo build --workspace --release` once so scaffold and download packages get compiled, otherwise they will have to be compiled on first run.*
|
||||
|
||||
### dotenv
|
||||
|
||||
|
||||
Reference in New Issue
Block a user