Skip to content

Commit 97199a5

Browse files
committed
README cleanup
1 parent 62ae94e commit 97199a5

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

README.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[Advent of Code][aoc] – an annual event in December since 2015.
44
Every year since then, with the first day of December, a programming puzzles contest is published every day for twenty-four days.
5-
A set of Christmas-oriented challenges provide any input you have to use to answer using the language of your choice.
5+
A set of Christmas-oriented challenges provides any input you have to use to answer using the language of your choice.
66
We offer you a template prepared to use with [Kotlin][kotlin] language within this repository.
77

88
![][file:cover]
@@ -17,25 +17,25 @@ After creating a new project based on this template in your account, a dedicated
1717
It will also personalize code to use your username and project name in namespaces and Gradle properties.
1818
How cool is that?
1919

20-
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.
20+
You can clone it within the IntelliJ IDEA whenever the [@actions-user][actions-user] actor pushes the second commit to your repository.
2121

2222
> [!IMPORTANT]
2323
>
2424
> Right after opening the project in IntelliJ IDEA, verify if you use at least **Java 11** as Project SDK.
2525
> To do that, visit [Project Structure Settings][docs-project-structure] (<kbd>⌘ Cmd</kbd><kbd>;</kbd> on macOS or <kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>Shift</kbd><kbd>S</kbd> on Windows/Linux).
2626
27-
From now, everything's in your hands!
28-
Join the [Advent of Code][aoc] contest, solve the *Day 01* as soon as it is published.
27+
From now on, everything's in your hands!
28+
Join the [Advent of Code][aoc] contest to solve the *Day 01* as soon as it is published.
2929

30-
For the following days, copy the `Day01.kt` solution file and increment the day number.
30+
Copy the `Day01.kt` solution file for the following days and increment the day number.
3131

3232
> [!NOTE]
3333
>
3434
> Remember to join the Kotlin contest!
35-
>
35+
>
3636
> To do that, edit your project's _About_ section with ⚙️ icon and add the `aoc-2023-in-kotlin` topic to your project.
37-
>
38-
> **We will find your repository and count you in our giveaway.**
37+
>
38+
> **We will find your repository and count you in our giveaway.**
3939
4040
## Setup
4141

@@ -46,12 +46,12 @@ After you create a new project based on the current template repository using th
4646
├── README.md README file
4747
├── build.gradle.kts Gradle configuration created with Kotlin DSL
4848
├── settings.gradle.kts Gradle project settings
49-
├── gradle* Gradle wraper files
49+
├── gradle* Gradle wrapper files
5050
└── src
5151
├── Day01.kt An empty implementation for the first AoC day
5252
├── Utils.kt A set of utility methods shared across your days
5353
54-
│ (files needed to be manually created)
54+
│ (create those files manually)
5555
├── Day01.txt An empty file for the Day 01 input data
5656
└── Day01_test.txt An optional Day 01 test input data used for checks
5757
```
@@ -60,8 +60,8 @@ After you create a new project based on the current template repository using th
6060
>
6161
> All task input files (`src/*.txt`) are excluded from the repository with `.gitignore` – we should not post them publicly, as [Eric Wastl requested for](https://twitter.com/ericwastl/status/1465805354214830081).
6262
63-
When the first puzzle appears, go to the `Day01.kt` and for each `part1` and `part2` functions, provide an algorithm implementation using the `input` data loaded from the `src/Day01.txt` file.
64-
This input data is common for both parts, and you can find it on the bottom of each day on the [Advent of Code][aoc] page.
63+
When the first puzzle appears, go to the `Day01.kt`, and for each `part1` and `part2` function, provide an algorithm implementation using the `input` data loaded from the `src/Day01.txt` file.
64+
This input data is common for both parts, and you can find it at the bottom of each day on the [Advent of Code][aoc] page.
6565

6666
To read the input data, you can go with the `readInput(name: String)` utility method provided in the [`Utils.kt`][file:utils] file, like:
6767

@@ -78,18 +78,18 @@ fun main() {
7878

7979
## Running
8080

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

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

8585
> [!IMPORTANT]
8686
>
87-
> Before running tasks or tests, make sure to create relevant files, like: `src/Day01.txt` or `src/Day01_test.txt`.
87+
> Create relevant files Before running tasks or tests, like: `src/Day01.txt` or `src/Day01_test.txt`.
8888
8989
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].
9090

9191
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.
92-
To handle that case, you can put such an input into a separated file and perform a check against the output, like:
92+
To handle that case, you can put such an input into a separate file and perform a check against the output, like:
9393

9494
```kotlin
9595
fun main() {
@@ -101,11 +101,11 @@ fun main() {
101101
```
102102

103103
The current approach of providing both `part1` and `part2` solutions within the single `Day##.kt` file may sometimes bring a disadvantage due to the first solution calculation when we expect to work on the second part only.
104-
With simple cases that don't consume too much of your time and resources that can be almost unnoticeable, but when solution takes seconds, it is worth considering breaking daily solution into two separated pieces, like `Day07_part1.kt` and `Day07_part2.kt`.
104+
With simple cases that don't consume too much of your time and resources that can be almost unnoticeable, but when the solution takes seconds, it is worth considering breaking the daily solution into two separated pieces, like `Day07_part1.kt` and `Day07_part2.kt`.
105105

106106
The final result of your algorithm will be printed on the screen so that you can pass it to the Advent of Code website.
107107

108-
To go with the next day, place the `Day02.txt` file into the `src` with relevant input data and create `Day02.kt` file with a similar code scaffold:
108+
To go with the next day, place the `Day02.txt` file into the `src` with relevant input data and create a `Day02.kt` file with a similar code scaffold:
109109

110110
```kotlin
111111
fun main() {
@@ -124,14 +124,14 @@ fun main() {
124124
```
125125

126126
> [!NOTE]
127-
>
128-
> There is a fork of this repository available which utilizes the Amper tool for project configuration, recently [introduced by JetBrains][amper].
129-
>
130-
> For more, see: [Advent of Code Kotlin Template — Amper][amper-template] project.
127+
>
128+
> There is a fork of this repository available that utilizes the Amper tool for project configuration, recently [introduced by JetBrains][amper].
129+
>
130+
> For more, see [Advent of Code Kotlin Template — Amper][amper-template] project.
131131
132132
## Getting help
133133

134-
If you stuck with Kotlin-specific questions or anything related to this template, check out the following resources:
134+
If you are stuck with Kotlin-specific questions or anything related to this template, check out the following resources:
135135

136136
- [Kotlin docs][docs]
137137
- [Kotlin Slack][slack]

0 commit comments

Comments
 (0)