checkstyle/README.md

68 lines
2.0 KiB
Markdown

[![][trend img]][trend]
[![][travis img]][travis]
[![][coverage img]][coverage]
[![][sonar img]][sonar]
CHECKSTYLE
==========
This directory contains the distribution for checkstyle. It is a tool for
checking Java source code for adherence to a set of rules.
The latest version can be found at http://checkstyle.sourceforge.net, see "Download" section.
Documentation is available in HTML format, see sub items of "Standard Checks".
Licensing
=========
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.
Continuous integration
======================
Travis: [![][travis img]][travis]
Feedback
========
Please send any feedback to https://groups.google.com/forum/?hl=en#!forum/checkstyle.
Bugs should be reported to the checkstyle bugtracker at
https://github.com/checkstyle/checkstyle/issues
[travis]:http://travis-ci.org/checkstyle/checkstyle
[travis img]:https://secure.travis-ci.org/checkstyle/checkstyle.png
[trend img]:https://d2weczhvl823v0.cloudfront.net/romani/checkstyle/trend.png
[trend]:https://bitdeli.com/free
[sonar]:http://nemo.sonarqube.org/dashboard/index/com.puppycrawl.tools:checkstyle
[sonar img]:http://nemo.sonarqube.org/images/sonarqube-24x100.png
[coverage]:https://coveralls.io/r/checkstyle/checkstyle
[coverage img]:https://coveralls.io/repos/checkstyle/checkstyle/badge.png
Thanks for trying out checkstyle!
Oliver Burn