pmd/README.md

# PMD

[![Join the chat at https://gitter.im/pmd/pmd](https://badges.gitter.im/pmd/pmd.svg)](https://gitter.im/pmd/pmd?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/pmd/pmd.svg?branch=master)](https://travis-ci.org/pmd/pmd)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd)
[![Coverage Status](https://coveralls.io/repos/github/pmd/pmd/badge.svg)](https://coveralls.io/github/pmd/pmd)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a674ee8642ed44c6ba7633626ee95967)](https://www.codacy.com/app/pmd/pmd?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=pmd/pmd&amp;utm_campaign=Badge_Grade)
## About

**PMD** is a source code analyzer. It finds common programming flaws like unused variables, empty catch blocks,
unnecessary object creation, and so forth. It supports Java, JavaScript, Salesforce.com Apex and Visualforce,
Modelica, PLSQL, Apache Velocity, XML, XSL, Scala.

Additionally it includes **CPD**, the copy-paste-detector. CPD finds duplicated code in
C/C++, C#, Dart, Fortran, Go, Groovy, Java, JavaScript, JSP, Kotlin, Lua, Matlab, Modelica,
Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex, Scala, Swift and Visualforce.

## Source and Documentation

Our latest source of PMD can be found on [GitHub](https://github.com/pmd/pmd). Fork us!

*   [How to build PMD](BUILDING.md)
*   [How to contribute to PMD](CONTRIBUTING.md)

The rule designer is developed over at [pmd/pmd-designer](https://github.com/pmd/pmd-designer).
Please see [its README](https://github.com/pmd/pmd-designer#contributing) for
developer documentation.

## News and Website

More information can be found on our [Website](https://pmd.github.io) and on [SourceForge](https://sourceforge.net/projects/pmd/).
#1441 PMD: Update documentation how to compile after modularization 2015-11-14 17:53:52 +01:00			`# PMD`
add a basic README.md file for github 2012-11-17 17:00:27 +01:00
Add Gitter badge 2018-01-11 07:48:19 +00:00			`[![Join the chat at https://gitter.im/pmd/pmd](https://badges.gitter.im/pmd/pmd.svg)](https://gitter.im/pmd/pmd?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
Add travis.yml - see https://travis-ci.org/pmd/pmd Cherry picked from master * 1a110587f005704a2e8354ef241cae23d35f5169 * 51f17c60104edd731bcfa0abcf6d617fae69d3ae * 36bc2c2dee8d3c64bcd73fcfb257b97fbcb9630f * cbf598c92c1ca251a4a7a2d8e3c30b49979d997b 2015-09-25 11:50:09 +02:00			`[![Build Status](https://travis-ci.org/pmd/pmd.svg?branch=master)](https://travis-ci.org/pmd/pmd)`
Add badge with latest version from maven central 2017-02-03 16:27:38 -03:00			`[![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.sourceforge.pmd/pmd)`
Add coveralls badge 2017-07-08 20:42:58 +02:00			`[![Coverage Status](https://coveralls.io/repos/github/pmd/pmd/badge.svg)](https://coveralls.io/github/pmd/pmd)`
Update README.md 2018-11-12 12:56:14 +01:00			`[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a674ee8642ed44c6ba7633626ee95967)](https://www.codacy.com/app/pmd/pmd?utm_source=github.com&utm_medium=referral&utm_content=pmd/pmd&utm_campaign=Badge_Grade)`
#1441 PMD: Update documentation how to compile after modularization 2015-11-14 17:53:52 +01:00			`## About`

Add CONTRIBUTING.md, BUILDING.md. Update README.md 2017-01-05 11:27:08 +01:00			`PMD is a source code analyzer. It finds common programming flaws like unused variables, empty catch blocks,`
[doc] Add scala as supported language 2019-09-07 16:19:24 +02:00			`unnecessary object creation, and so forth. It supports Java, JavaScript, Salesforce.com Apex and Visualforce,`
[modelica] Initial implementation of Modelica support for PMD 2019-09-28 16:21:58 +03:00			`Modelica, PLSQL, Apache Velocity, XML, XSL, Scala.`
add a basic README.md file for github 2012-11-17 17:00:27 +01:00
Add CONTRIBUTING.md, BUILDING.md. Update README.md 2017-01-05 11:27:08 +01:00			`Additionally it includes CPD, the copy-paste-detector. CPD finds duplicated code in`
[modelica] Initial implementation of Modelica support for PMD 2019-09-28 16:21:58 +03:00			`C/C++, C#, Dart, Fortran, Go, Groovy, Java, JavaScript, JSP, Kotlin, Lua, Matlab, Modelica,`
Remove XSL / XML from CPD support 2019-04-10 16:22:38 -03:00			`Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex, Scala, Swift and Visualforce.`
#1441 PMD: Update documentation how to compile after modularization 2015-11-14 17:53:52 +01:00
Add CONTRIBUTING.md, BUILDING.md. Update README.md 2017-01-05 11:27:08 +01:00			`## Source and Documentation`
Update readme 2013-05-01 14:56:22 +02:00
Add CONTRIBUTING.md, BUILDING.md. Update README.md 2017-01-05 11:27:08 +01:00			`Our latest source of PMD can be found on [GitHub](https://github.com/pmd/pmd). Fork us!`
#1441 PMD: Update documentation how to compile after modularization 2015-11-14 17:53:52 +01:00
Add CONTRIBUTING.md, BUILDING.md. Update README.md 2017-01-05 11:27:08 +01:00			`* [How to build PMD](BUILDING.md)`
			`* [How to contribute to PMD](CONTRIBUTING.md)`
#1441 PMD: Update documentation how to compile after modularization 2015-11-14 17:53:52 +01:00
Update CONTRIBUTING, README 2019-03-03 11:54:41 +01:00			`The rule designer is developed over at [pmd/pmd-designer](https://github.com/pmd/pmd-designer).`
			`Please see [its README](https://github.com/pmd/pmd-designer#contributing) for`
			`developer documentation.`

#1441 PMD: Update documentation how to compile after modularization 2015-11-14 17:53:52 +01:00			`## News and Website`

Add CONTRIBUTING.md, BUILDING.md. Update README.md 2017-01-05 11:27:08 +01:00			`More information can be found on our [Website](https://pmd.github.io) and on [SourceForge](https://sourceforge.net/projects/pmd/).`