Skip to content

Commit e0b87fc

Browse files
committed
Update end-user README
1 parent 7d6cb11 commit e0b87fc

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

.github/template-cleanup/README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
1+
![Tests](https://github.com/%REPOSITORY%/workflows/Tests/badge.svg)
2+
13
# %NAME%
24

3-
![Tests](https://github.com/%REPOSITORY%/workflows/Tests/badge.svg)
5+
Welcome to the Advent of Code[^aoc] Kotlin project created by [%NAME%][github] using the [Advent of Code Kotlin Template][template] delivered by JetBrains.
6+
7+
In this repository, %NAME% is about to provide solutions for the puzzles using [Kotlin][kotlin] language.
8+
9+
If you stuck with Kotlin-specific questions or anything related to this template, check out the following resources:
10+
11+
- [Kotlin docs][docs]
12+
- [Kotlin Slack][slack]
13+
- Template [issue tracker][issues]
14+
415

5-
---
6-
Repository based on the [Advent of Code Kotlin Template][template].
16+
[^aoc]:
17+
[Advent of Code][aoc] – an annual event in December since 2015.
18+
Every year since then, with the first day of December, a programming puzzles contest is published every day for twenty-four days.
19+
A set of Christmas-oriented challenges provide any input you have to use to answer using the language of your choice.
720

21+
[aoc]: https://adventofcode.com
22+
[docs]: https://kotlinlang.org/docs/home.html
23+
[github]: https://github.com/%NAME%
24+
[issues]: https://github.com/kotlin-hands-on/advent-of-code-kotlin-template/issues
25+
[kotlin]: https://kotlinlang.org
26+
[slack]: https://surveys.jetbrains.com/s3/kotlin-slack-sign-up
827
[template]: https://github.com/hsz/advent-of-code-kotlin-template

0 commit comments

Comments
 (0)