nayrid.com / java-template
Opinionated java-library project template
fork atom
java-template / readme.md
at main 833 B view raw view code
kokirigla.de feat: jetbrains annotations, fix publishing
e87d2702

template#

This template is marked CC0 1.0.

The license.txt and license_header.txt this template provides are MIT. You will want to change them if your project will be released under a different license. Remember to change the license declaration in base-conventions.gradle.kts too.

Quick start#

Run the rename script to set your group, project name, and Java package:

./.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"

Checkstyle#

This template uses checkstyle. For checkstyle support in IntelliJ IDEA:

  1. Install the checkstyle plugin.
  2. In the Checkstyle tab, set the configuration file to .checkstyle/checkstyle.xml.