Add generic installation instruction
This commit is contained in:
parent
67ce6546fe
commit
91c9556bd9
1 changed files with 10 additions and 2 deletions
12
README.md
12
README.md
|
@ -7,9 +7,17 @@
|
||||||
[](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-pmd)
|
[](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-pmd)
|
||||||
[](https://github.com/rife2/bld-pmd/actions/workflows/bld.yml)
|
[](https://github.com/rife2/bld-pmd/actions/workflows/bld.yml)
|
||||||
|
|
||||||
To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions).
|
To install the latest version, add the following to the `lib/bld/bld-wrapper.properties` file:
|
||||||
|
|
||||||
To check all source code using the [Java Quickstart](https://docs.pmd-code.org/latest/pmd_rules_java.html) configuration, add the following to your build file:
|
```properties
|
||||||
|
bld.extension-pmd=com.uwyn.rife2:bld-pmd
|
||||||
|
```
|
||||||
|
|
||||||
|
For more information, please refer to the [extensions](https://github.com/rife2/bld/wiki/Extensions) documentation.
|
||||||
|
|
||||||
|
## Check Source with PMD
|
||||||
|
|
||||||
|
To check all source Codecode using the [Java Quickstart](https://docs.pmd-code.org/latest/pmd_rules_java.html) configuration, add the following to your build file:
|
||||||
|
|
||||||
```java
|
```java
|
||||||
@BuildCommand(summary = "Checks source code with PMD")
|
@BuildCommand(summary = "Checks source code with PMD")
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue