Add template usage instructions

This commit is contained in:
akp 2020-12-05 17:03:43 +00:00
parent 8fd630d6fd
commit e9cb627d25
No known key found for this signature in database
GPG key ID: D3E7EAA31B39637E
4 changed files with 33 additions and 24 deletions

BIN
.github/image-20201205170258549.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

View file

@ -1,22 +1,15 @@
# Day 1: Report Repair # How to use this template
<details><summary>Challenge description</summary> 1. Create a new copy of the `template` directory, and name it as you please. Enter into that directory.
2. Download your challenge input, and save it as `input.txt`.
3. Edit `info.json` to include the challenge title, year and day number as well as any test cases you would like to include.
4. Write your code.
- If you're using the Go template, ensure you change the import path in `main.go` to `"adventOfCode/<yourDirectory>/go/challenge"`.
5. Run your code.
- Python: `python ./python`. You may also need to run `pip install -r ../requirements.txt`.
- Go: `go run ./go`
6. (optional) Delete the copy of this README, rename the other README and edit it.
## Part One
...
## Part Two ![image-20201205170258549](https://github.com/codemicro/adventOfCode/blob/master/.github/image-20201205170258549.png?raw=true)
...
</details>
<details><summary>Script output</summary>
```
python .\python
...
```
</details>

22
template/README.md.off Normal file
View file

@ -0,0 +1,22 @@
# Day 1: Report Repair
<details><summary>Challenge description</summary>
## Part One
...
## Part Two
...
</details>
<details><summary>Script output</summary>
```
python .\python
...
```
</details>

View file

@ -12,12 +12,6 @@ import (
"github.com/fatih/color" "github.com/fatih/color"
) )
const (
year = "2020"
day = "1"
title = "Report Repair"
)
func main() { func main() {
var infoStruct info var infoStruct info
{ {