Skip to content

Commit 4bb6af3

Browse files
committed
Update readme
1 parent 51c7154 commit 4bb6af3

File tree

1 file changed

+37
-15
lines changed

1 file changed

+37
-15
lines changed

README.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
1-
PMD Eclipse Plugin
2-
==================
1+
# PMD Eclipse Plugin
32

4-
Compilation
5-
-----------
3+
Release Notes: <https://github.com/pmd/pmd-eclipse-plugin/blob/master/ReleaseNotes.md>
4+
5+
## How to contribute
6+
7+
You can contribute by testing the latest version, creating bug reports, or even forking
8+
the repository on github and create pull requests. Any contributions are welcome!
9+
10+
11+
### Testing the latest version
12+
The latest version of the plugin can be found on sourceforge. Use the following
13+
Update Site URL in order to install the latest SNAPSHOT version into your eclipse:
14+
15+
<https://sourceforge.net/projects/pmd/files/pmd-eclipse/update-site-latest/>
16+
17+
### Bug Reports
18+
Please file any bug reports in the bug tracker at sourceforge:
19+
20+
<https://sourceforge.net/p/pmd/bugs/>
21+
22+
### GitHub Repository
23+
24+
Just fork the the GitHub Repository pmd/pmd-eclipse-plugin and create a pull request.
25+
26+
<https://github.com/pmd/pmd-eclipse-plugin/>
27+
28+
To get started, see also the next section.
29+
30+
31+
## Short Developer's Guide
32+
33+
### Compilation
634
Simply run `mvn clean install`. The plugin's update site will be generated in
735
`net.sourceforge.pmd.eclipse.p2updatesite/target/repository`. You can use this directory as
836
an update site to install the new plugin version directly into your Eclipse.
937

10-
Importing the projects in Eclipse
11-
---------------------------------
38+
### Importing the projects in Eclipse
1239
Make sure you have the Maven Integration (m2e - http://eclipse.org/m2e/) installed. Then you can
1340
import *Existing Maven Projects*.
1441
You should see 6 projects:
@@ -20,15 +47,13 @@ You should see 6 projects:
2047
* net.sourceforge.pmd.eclipse.plugin.test - the (unit) tests for the plugin
2148
* net.sourceforge.pmd.eclipse.plugin.test.fragment - an example extension of the plugin used during the tests
2249

23-
Debugging
24-
---------
50+
### Debugging
2551
You can run eclipse with debugging enabled and connect to it via remote debugging:
2652

2753
eclipse -data workspace-directory -vmargs -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
2854

2955

30-
Releasing and updating the official eclipse update site
31-
-------------------------------------------------------
56+
### Releasing and updating the official eclipse update site
3257

3358
# Pick a release BUILDQUALIFIER (e.g. v20130420-0001) and update versions
3459
E.g. version is: "4.0.0" and BUILDQUALIFIER is "v20130420-0001".
@@ -97,17 +122,14 @@ You can use the following template:
97122

98123

99124

100-
101-
Updating the used PMD version
102-
-----------------------------
125+
### Updating the used PMD version
103126
The parent pom contains the property `pmd.version`. This is used inside the plugin module, to resolve the dependencies.
104127
In order to change the PMD version, change this property and rebuild (`mvn clean package`). In case PMD has some
105128
changed (added/removed) transitive dependencies, you'll need to update `n.s.p.e.plugin/META-INF/MANIEFEST.MF` as well.
106129
All transitive dependencies are copied into the folder `n.s.p.e.plugin/target/lib` during the build.
107130

108131

109-
Useful References
110-
-----------------
132+
## Useful References
111133

112134
* <http://wiki.eclipse.org/Equinox/p2/Publisher>
113135
* <http://wiki.eclipse.org/Equinox_p2_Repository_Mirroring>

0 commit comments

Comments
 (0)