feat: initial commit
This commit is contained in:
27
README.md
Normal file
27
README.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# Advent-of-Code
|
||||
|
||||
## Project overview
|
||||
|
||||
### Project structure
|
||||
- `data/` :
|
||||
- `example/`: example files go here
|
||||
- `input/`: this directory is gitignored, input files go here
|
||||
- `aoc/` : cli implementation
|
||||
- `src/` :
|
||||
- `solution/year_<year>/day_<day>.py`: solution files
|
||||
- `.env.example`: example dotenv file
|
||||
|
||||
### cli
|
||||
- `python main.py create [-y <year>] <day>`: prepare solution files for `day`
|
||||
- `python main.py download [-y <year>] <day>`: download input file for `day`
|
||||
- `python main.py solve [-y <year>] <day>`: run solution against input for `day`
|
||||
|
||||
### dotenv
|
||||
|
||||
set `AOC_SESSION_TOKEN` to AoC session Cookie
|
||||
|
||||
### FAQ
|
||||
|
||||
#### How are your commits numbered in ascending order?
|
||||
[https://westling.dev/b/extremely-linear-git](https://westling.dev/b/extremely-linear-git)
|
||||
|
||||
Reference in New Issue
Block a user