diff --git a/builder/src/main/resources/readme/README.disabled.header.md b/builder/src/main/resources/readme/README.disabled.header.md deleted file mode 100644 index 0703dd1..0000000 --- a/builder/src/main/resources/readme/README.disabled.header.md +++ /dev/null @@ -1 +0,0 @@ -These checks are not enabled. Notes are included for each explaining why. diff --git a/builder/src/main/resources/readme/README.disabled.sevntu.header.md b/builder/src/main/resources/readme/README.disabled.sevntu.header.md deleted file mode 100644 index 6e58dce..0000000 --- a/builder/src/main/resources/readme/README.disabled.sevntu.header.md +++ /dev/null @@ -1 +0,0 @@ -As the sevntu check are considered experimental not all those that are not enabled are listed here. Only where they are disabled due to a conflict with my 'style' or there is another irreconcilable difference that prevents them from being enabled, will they be documented to prevent repeated investigations. diff --git a/builder/src/main/resources/readme/README.enabled.header.md b/builder/src/main/resources/readme/README.enabled.header.md deleted file mode 100644 index fa3e2c0..0000000 --- a/builder/src/main/resources/readme/README.enabled.header.md +++ /dev/null @@ -1 +0,0 @@ -The following is a list of each of the checks and the expectations each has on your code. diff --git a/builder/src/main/resources/readme/README.footer.md b/builder/src/main/resources/readme/README.footer.md deleted file mode 100644 index 05057a1..0000000 --- a/builder/src/main/resources/readme/README.footer.md +++ /dev/null @@ -1 +0,0 @@ -[Effective Java]: http://amzn.to/2aSz6GE diff --git a/builder/src/main/resources/readme/README.header.md b/builder/src/main/resources/readme/README.header.md deleted file mode 100644 index 707097c..0000000 --- a/builder/src/main/resources/readme/README.header.md +++ /dev/null @@ -1,92 +0,0 @@ -# kemitix-checkstyle-ruleset - -Provides an extensive Checkstyle ruleset for use with Apache's `maven-checkstyle-plugin`. - -The ruleset includes checks from both the core Checkstyle library and from the Sevntu-Checkstyle library. - -* [Requirements](#requirements) -* [Usage](#usage) -* [All Checks](#all-checks) -* [Enabled Checks](#enabled-checks) - * [Checkstyle](#checkstyle) - * [Sevntu](#sevntu) -* [Disabled Checks](#disabled-checks) - * [Checkstyle](#checkstyle-1) - * [Sevntu](#sevntu-1) - -## Requirements - -* [maven-checkstyle-plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/) 2.17+ -* [Checkstyle](http://checkstyle.sourceforge.net/) 7.0+ -* [Sevntu-checkstyle](http://sevntu-checkstyle.github.io/sevntu.checkstyle/) 1.21.0+ - -## Usage - -To use this ruleset in your `maven-checkstyle-plugin` configuration add `checkstyle`, `sevntu-checkstyle-maven-plugin` and `kemitix-checktyle-ruleset` as dependencies of the `maven-checkstyle-plugin`. - -You need to include `checkstyle` as the version bundled with the `maven-checkstyle-plugin` is not up-to-date enough. - -Select the `configLocation` for the level of strictness required: - -* checkstyle-1-layout.xml -* checkstyle-2-naming.xml -* checkstyle-3-javadoc.xml -* checkstyle-4-tweaks.xml -* checkstyle-5-complexity.xml - -Only specify a single `configLocation` as each increasing level includes all the rules -from the previous. - -```` - - 7.3 - 1.22.0 - 0.2.0 - - - - - org.apache.maven.plugins - maven-checkstyle-plugin - - - com.puppycrawl.tools - checkstyle - ${checkstyle.version} - - - com.github.sevntu.checkstyle - sevntu-checkstyle-maven-plugin - ${sevntu-checkstyle-maven-plugin.version} - - - net.kemitix - kemitix-checkstyle-ruleset - ${kemitix-checkstyle-ruleset.version} - - - - net/kemitix/checkstyle-5-complexity.xml - - - - - - - org.apache.maven.plugins - maven-checkstyle-plugin - - - validate - validate - - check - checkstyle - - - - - -```` - -## All Checks