Skip to content

Commit 0e0ee4f

Browse files
committed
README update
1 parent e164622 commit 0e0ee4f

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
# Advent of Code Kotlin Template
22

3-
[Advent of Code][aoc] – an annual event that happens in December since 2015.
4-
Every year since then, with the first of December, a programming puzzles contest are published every day for twenty-four days.
5-
A set of Christmas-oriented challenges provide an input you have to use to provide an answer using the language of your choice.
6-
Within this repository, we offer you a template prepared to use with [Kotlin][kotlin] language.
3+
[Advent of Code][aoc] – an annual event in December since 2015.
4+
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.
6+
We offer you a template prepared to use with [Kotlin][kotlin] language within this repository.
77

88
## Workflow
9-
**Advent of Code Kotlin Template** is a special type of GitHub repository which lets you speed up the preparation phase and start writing your solutions immediately.
9+
**Advent of Code Kotlin Template** is a particular type of GitHub repository that lets you speed up the setup phase and start writing your AoC solutions immediately.
10+
11+
The general idea is straightforward – to create a new project based on this template, you need to log in to your GitHub account and use the **Use this template** green button.
12+
And remember – **do not fork it!**
13+
14+
After creating a new project based on this template in your account, a dedicated GitHub Actions workflow will start and clean up the code from redundant files.
15+
It will also personalize code to use your username and project name in namespaces and Gradle properties.
16+
How cool is that?
17+
18+
Right after the @actions-user actor pushes the second commit to your repository, you're ready to clone it within the IntelliJ IDEA.
1019

1120
![file:kotlin]
1221

0 commit comments

Comments
 (0)