Skip to content

Commit 0507e29

Browse files
committed
Update readme to include checkstyle location
1 parent bc573f5 commit 0507e29

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -685,6 +685,12 @@ Use the Maven wrapper to create a jar including all dependencies
685685

686686
mvnw clean install
687687

688+
### Checkstyle Config File
689+
690+
This project uses my [`common-parent`](https://bintray.com/patrickfav/maven/mvn-common-parent) which centralized a lot of
691+
the plugin versions aswell as providing the checkstyle config rules. Specifically they are maintained in [`checkstyle-config`](https://bintray.com/patrickfav/maven/checkstyle-config). Locally the files will be copied after you `mvnw install` into your `target` folder and is called
692+
`target/checkstyle-checker.xml`. So if you use a plugin for your IDE, use this file as your local configuration.
693+
688694
## Tech Stack
689695

690696
* Java 7 (+ [errorprone](https://github.com/google/error-prone) static analyzer)

0 commit comments

Comments
 (0)