readme.md 2.42 KB
Newer Older
Florian Echternkamp's avatar
Florian Echternkamp committed
1 2
# Kieker Eclipse Plugin

3 4 5 6
## Install
So far, we do not provide an Eclipse Updatesite. Hence, you need to install the plugin from your file system.

Necessary steps to install the plugin:
Christian Wulf's avatar
Christian Wulf committed
7
- Download (or clone) this repository
8
- Inside Eclipse go to Help -> Install New Software... 
Christian Wulf's avatar
Christian Wulf committed
9
- Add to the *Work with* textbox the path to the following folder: `file/.../kieker.tools.eclipse.parent/kieker.tools.eclipse.repository/target/repository`
Christian Wulf's avatar
Christian Wulf committed
10
- Select either the category *Kieker - the monitoring and dynamic analysis framework* or, explicitly, the feature *Combined Kieker Feature: Monitoring and Analysis*
11 12 13 14 15 16 17 18 19 20 21 22 23
- Click *Next*, *Next*, accept the License Agreement and click Finish
- Wait... when a Security Warning appears due to *unsigned content* click ok
- Restart Eclipse by clicking *Yes*
- Both plug-ins are installed now!

## Manual
Please read our [short paper](http://eprints.uni-kiel.de/34633/) for usage instructions.

## Build
If you want to build the plugin by your own, which is not necessary, then execute
``mvn clean package`` 
within the directory ``kieker.tools.eclipse.parent``.

Florian Echternkamp's avatar
Florian Echternkamp committed
24
## Project structure
Florian Echternkamp's avatar
Florian Echternkamp committed
25 26 27 28 29 30
+ kieker.tools.eclipse.parent
    + kieker.tools.eclipse.analysis
    + kieker.tools.eclipse.analysis.nl1
    + kieker.tools.eclipse.dependencies
    + kieker.tools.eclipse.feature
    + kieker.tools.eclipse.monitoring
31
    + kieker.tools.eclipse.updatesite
Florian Echternkamp's avatar
Florian Echternkamp committed
32 33 34 35 36 37 38 39 40 41 42 43
    
#### kieker.tools.eclipse.parent
All common settings are stored in the parent `pom.xml`, e.g. the Tycho version or the target version of Eclipse. The sub-projects `pom.xml` inherit from this parent `pom.xml`. 

> Eclipse uses the Maven POM, but isn't using the normal Maven Build process. Instead Tycho is used, which also depends on the MANIFEST. **Important**: Tycho uses p2- instead of m2-Repositories. Therefore no normal m2-Repositories can be used for dependencies. Read more at _kieker.tools.eclipse.dependencies_

#### kieker.tools.eclipse.analysis
#### kieker.tools.eclipse.analysis.nl1
#### kieker.tools.eclipse.dependencies
Because Tycho can not use non-OSGI .m2-Repositories this sub-project is used for dependencies using .m2 instead. Its `pom.xml` does not inherit from the parents `pom.xml` and won't use tycho. 

#### kieker.tools.eclipse.feature
44
Contains the only feature of the Kieker Eclipse Plugin
Florian Echternkamp's avatar
Florian Echternkamp committed
45
#### kieker.tools.eclipse.monitoring
46 47
#### kieker.tools.eclipse.updatesite
Contains the updatesite repository which you can use to install the Kieker Eclipse plugin into your Eclipse.
Florian Echternkamp's avatar
Florian Echternkamp committed
48