diff --git a/README.md b/README.md index 5684d034..261da1e0 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,15 @@ [![GitHub Actions](https://github.com/uhafner/codingstyle-pom/workflows/GitHub%20CI/badge.svg)](https://github.com/uhafner/codingstyle-pom/actions) [![License: MIT](https://img.shields.io/badge/license-MIT-yellow.svg)](https://en.wikipedia.org/wiki/MIT_License) -Each Java project should follow a given coding style. I.e., all contributions to the source code should use the same -formatting rules, design principles, code patterns, idioms, etc. I published such a coding style in my -[GitHub project 'codingstyle'](https://github.com/uhafner/codingstyle). I am using this coding style in my lectures about -software development at Munich University of Applied Sciences and in all of my open source projects. +Each Java project should follow a given coding style. +I.e., all contributions to the source code should use the same formatting rules, design principles, code patterns, idioms, etc. +I published such a coding style in my [GitHub project 'codingstyle'](https://github.com/uhafner/codingstyle). +I am using this coding style in my lectures about software development at Munich University of Applied Sciences and in all of my open source projects. -If you want to use this coding style as well you can use this [Maven POM](pom.xml) as parent of you own POM. Then you -get the configuration of the following tools for free: +If you want to use this coding style as well, you can use this [Maven POM](pom.xml) as parent of your own POM. +Then you get the configuration of the following tools for free: - [Java Compiler](https://openjdk.java.net/groups/compiler/) -- [JavaDoc Tool](https://www.oracle.com/technetwork/java/javase/documentation/javadoc-137458.html) +- [Javadoc Tool](https://www.oracle.com/java/technologies/javase/javadoc.html) - [Checkstyle](https://checkstyle.org) - [PMD](https://pmd.github.io/) - [SpotBugs](https://spotbugs.github.io)