Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
hsz committed Nov 21, 2023
1 parent d67077d commit 291353a
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,19 @@ How cool is that?
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.

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

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

> **Note**
>
> Remember to join the Kotlin contest!
>
> To do that, edit your project's _About_ section with ⚙️ icon and add the `aoc-2022-in-kotlin` topic to your project.
> To do that, edit your project's _About_ section with ⚙️ icon and add the `aoc-2023-in-kotlin` topic to your project.
>
> **We will find your repository and count you in our giveaway.**
## Content
## Setup

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:

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

> **Note**
Expand All @@ -67,6 +71,16 @@ fun main() {
}
```

## Running

To call the algorithm you're implementing, click on the green Play button next to the `fun main()` definition.

![img.png](.github/readme/run.png)

> **Warning**
>
> Before running tasks or tests, make sure to create relevant files, like: `src/Day01.txt` or `src/Day01_test.txt`.
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].

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.
Expand Down

0 comments on commit 291353a

Please sign in to comment.