Skip to content

Commit c59df73

Browse files
authored
Merge pull request #100 from kgibm/issue99
[Fix #99] Clarify Contributor Reference
2 parents 101ab33 + b8def83 commit c59df73

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

dev-doc/Contributor_Reference.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,18 @@ https://github.com/eclipse-mat/mat
1414

1515
### Setup Eclipse as IDE
1616

17-
You need a recent Eclipse installation. Memory Analyzer is a set of eclipse plugins, therefore you'll need the appropriate tooling for plugin development. The ''Eclipse IDE for Eclipse Committers'' is an appropriate package.
18-
19-
There are eclipse .project files as part of MATs source code, so that the projects (plugins, features, etc...) can be easily imported into the Eclipse IDE.
20-
21-
Dependencies - you'll need the following to be able to compile MAT
22-
23-
The easiest way to setup all dependencies is to use a target platform definition file, which can be found in org.eclipse.mat.targetdef. Open the most recent one with the Target Definition Editor and select ''Set as Active Target Platform''. After this, all projects should compile.
24-
25-
Alternatively, if you don't want to use the predefined target platform definition, you'll should install via the update manager
26-
* Eclipse BIRT Framework
27-
* IBM Diagnostic Tool Framework for Java - See [IBM Diagnostic Tool Framework for Java Version 1.12](https://www.ibm.com/docs/en/sdk-java-technology/8?topic=interfaces-dtfj). An Update Site is available [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/runtimes/tools/dtfj/). This is needed to compile and run with the DTFJ adapter which is part of Memory Analyzer and allows Memory Analyzer to read dumps from IBM virtual machines for Java.
17+
You need a recent Eclipse installation. Memory Analyzer is a set of eclipse plugins, therefore you'll need the appropriate tooling for plugin development. The [''Eclipse IDE for Eclipse Committers''](https://www.eclipse.org/downloads/packages/) is an appropriate package.
18+
19+
1. Clone MAT source:
20+
```
21+
git clone https://github.com/eclipse-mat/mat
22+
```
23+
2. Import projects: File } Import... } Maven } Existing Maven Projects } Select your cloned MAT source directory
24+
3. Dependencies: Choose one of the following options to be able to compile MAT:
25+
1. The easiest way to setup all dependencies is to use a target platform definition file, which can be found in org.eclipse.mat.targetdef. Open the most recent one with the Target Definition Editor and select ''Set as Active Target Platform''. After this, all projects should compile.
26+
2. Alternatively, you'll need to install some plugins using the update manager:
27+
* Eclipse BIRT Framework.
28+
* IBM Diagnostic Tool Framework for Java - See [IBM Diagnostic Tool Framework for Java Version 1.12](https://www.ibm.com/docs/en/sdk-java-technology/8?topic=interfaces-dtfj). An Update Site is available [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/runtimes/tools/dtfj/). This is needed to compile and run with the DTFJ adapter which is part of Memory Analyzer and allows Memory Analyzer to read dumps from IBM virtual machines for Java.
2829

2930
If you do not have BIRT installed then there will be compilation errors in the org.eclipse.mat.chart and org.eclipse.mat.chart.ui projects.
3031

0 commit comments

Comments
 (0)