73 lines
2.8 KiB
Markdown
73 lines
2.8 KiB
Markdown
[![][travis img]][travis]
|
|
[![][coverage img]][coverage]
|
|
[![][mavenbadge img]][mavenbadge]
|
|
[![][versioneye img]][versioneye]
|
|
[![][sonar img]][sonar]
|
|
|
|
|
|
|
|
Checkstyle is a tool for
|
|
checking Java source code for adherence to a Code Standard or set of validation rules (best practices).
|
|
|
|
The latest version can be found at [SourceForge downloads](https://sourceforge.net/projects/checkstyle/files/checkstyle/) or at [Maven repo](http://repo1.maven.org/maven2/com/puppycrawl/tools/checkstyle/).
|
|
|
|
Documentation is available in HTML format, see http://checkstyle.sourceforge.net/checks.html.
|
|
|
|
Continuous integration and Quality reports
|
|
======================
|
|
Travis: [![][travis img]][travis]
|
|
|
|
Quality reports: http://checkstyle.sourceforge.net/project-reports.html
|
|
|
|
Feedback/Support
|
|
========
|
|
|
|
Please send any feedback to https://groups.google.com/forum/?hl=en#!forum/checkstyle
|
|
|
|
Questions and Answers from community: http://stackoverflow.com/questions/tagged/checkstyle
|
|
|
|
Bugs and Feature requests: https://github.com/checkstyle/checkstyle/issues
|
|
|
|
Licensing
|
|
=========
|
|
|
|
[![][license img]][license]
|
|
|
|
This software is licensed under the terms in the file named "LICENSE" in this
|
|
directory.
|
|
|
|
The software uses the ANTLR package (http://www.antlr.org). Its license terms
|
|
are in the file named "RIGHTS.antlr" in this directory.
|
|
|
|
This product includes software developed by
|
|
The Apache Software Foundation (http://www.apache.org/).
|
|
|
|
The software uses the Cli, Logging and Beanutils packages from the
|
|
Apache Commons project (http://commons.apache.org/). The license terms
|
|
of these packages are in the file named "LICENSE.apache20" in this
|
|
directory.
|
|
|
|
The software uses the Google Guava Libraries
|
|
(https://code.google.com/p/guava-libraries/). The license terms of
|
|
these packages are in the file named "LICENSE.apache20" in this
|
|
directory.
|
|
|
|
|
|
[travis]:http://travis-ci.org/checkstyle/checkstyle
|
|
[travis img]:https://secure.travis-ci.org/checkstyle/checkstyle.png
|
|
|
|
[sonar]:http://nemo.sonarqube.org/dashboard/index/com.puppycrawl.tools:checkstyle
|
|
[sonar img]:https://dev.eclipse.org/sonar/images/sonarqube-24x100.png
|
|
|
|
[coverage]:https://coveralls.io/r/checkstyle/checkstyle
|
|
[coverage img]:https://coveralls.io/repos/checkstyle/checkstyle/badge.png
|
|
|
|
[license]:LICENSE
|
|
[license img]:https://img.shields.io/badge/license-GNU%20LGPL%20v2.1-blue.svg
|
|
|
|
[mavenbadge]:http://search.maven.org/#search|gav|1|g%3A%22com.puppycrawl.tools%22%20AND%20a%3A%22checkstyle%22
|
|
[mavenbadge img]:https://maven-badges.herokuapp.com/maven-central/com.puppycrawl.tools/checkstyle/badge.svg
|
|
|
|
[versioneye]:https://www.versioneye.com/user/projects/5504ca834a1064774400049a
|
|
[versioneye img]:https://www.versioneye.com/user/projects/5504ca834a1064774400049a/badge.svg
|