Skip to content

Commit 291353a

Browse files
committed
README update
1 parent d67077d commit 291353a

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,19 @@ How cool is that?
2020
Right after the [@actions-user][actions-user] actor pushes the second commit to your repository, you're ready to clone it within the IntelliJ IDEA.
2121

2222
From now, everything's in your hands!
23-
Join the [Advent of Code][aoc] contest, solve the Day O1 as soon as it is published.
23+
Join the [Advent of Code][aoc] contest, solve the *Day 01* as soon as it is published.
2424

2525
For the following days, copy the `Day01.kt` solution file and increment the day number.
2626

27+
> **Note**
28+
>
2729
> Remember to join the Kotlin contest!
2830
>
29-
> To do that, edit your project's _About_ section with ⚙️ icon and add the `aoc-2022-in-kotlin` topic to your project.
31+
> To do that, edit your project's _About_ section with ⚙️ icon and add the `aoc-2023-in-kotlin` topic to your project.
3032
>
3133
> **We will find your repository and count you in our giveaway.**
3234
33-
## Content
35+
## Setup
3436

3537
After you create a new project based on the current template repository using the **Use this template** button, a bare minimal scaffold will appear in your GitHub account with the following structure:
3638

@@ -42,9 +44,11 @@ After you create a new project based on the current template repository using th
4244
├── gradle* Gradle wraper files
4345
└── src
4446
├── Day01.kt An empty implementation for the first AoC day
47+
├── Utils.kt A set of utility methods shared across your days
48+
49+
│ (files needed to be manually created)
4550
├── Day01.txt An empty file for the Day 01 input data
46-
├── Day01_test.txt An optional Day 01 test input data used for checks
47-
└── Utils.kt A set of utility methods shared across your days
51+
└── Day01_test.txt An optional Day 01 test input data used for checks
4852
```
4953

5054
> **Note**
@@ -67,6 +71,16 @@ fun main() {
6771
}
6872
```
6973

74+
## Running
75+
76+
To call the algorithm you're implementing, click on the green Play button next to the `fun main()` definition.
77+
78+
![img.png](.github/readme/run.png)
79+
80+
> **Warning**
81+
>
82+
> Before running tasks or tests, make sure to create relevant files, like: `src/Day01.txt` or `src/Day01_test.txt`.
83+
7084
The [`Utils.kt`][file:utils] file also contains the `String.md5()` method for generating MD5 hash out of the given string and expects more helper functions for the sake of the [KISS principle][kiss].
7185

7286
Each puzzle describes some test conditions, a small portion of the information that helps check if the produced value for the given test input is valid.

0 commit comments

Comments
 (0)