nayrid.com
Opinionated java-library project template
kokirigla.de
1# template
2
3This template is marked [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/).
4
5The `license.txt` and `license_header.txt` this template provides are MIT. You will want to change
6them if your project will be released under a different license. Remember to change the license
7declaration in `base-conventions.gradle.kts` too.
8
9## Quick start
10
11Run the rename script to set your group, project name, and Java package:
12
13```bash
14./.scripts/rename-template.sh -g "com.acme" -p "my-project" -n "acmeRepo" -s "https://repo.acme.com/snapshots" -r "https://repo.acme.com/releases" -a "Acme, Inc." -y "2026"
15```
16
17## Checkstyle
18
19This template uses checkstyle. For checkstyle support in IntelliJ IDEA:
20
211. Install the checkstyle plugin.
222. In the `Checkstyle` tab, set the configuration file to `.checkstyle/checkstyle.xml`.