Add readme.md

README.md

+# PMX-PCM
+
+![logo](https://se.informatik.uni-wuerzburg.de/fileadmin/_processed_/csm_PMX_logo_9cc52150f8.png)
+
+This project allows to create the [Descartes Modeling Language (DML)](http://descartes.tools/dml/) (DML) models
+from [Kieker](http://kieker-monitoring.net/) monitoring traces.
+It replaces a manual creation of architectural performance models which is very complex, time intense, and error prone.
+At this, it is based upon the generic [Performance Model eXtractor (PMX)](https://se3.informatik.uni-wuerzburg.de/descartes/pmx) project which
+automates the extraction of architectural performance models.
+
+## Usage
+
+### Extraction parameters
+Run programm using --help to see how to pass input parameters for performance model extraction.
+
+**Example:**
+-i inputFolder -o outputFolder -n=numberOfCoresCPU1=4
+
+### Running within Eclipse
+* Import project into workspace
+* Set targetplatform
+* Create a new (java application) run configuration and select
+*tools.descartes.pmx.pcm.console* as Project and for the Main- Class select
+*tools.descartes.pmx.pcm.console.PMXCommandLinePCM*. Using this Run Configuration will be able to run the PMXCommandLine correctly.
+
+### Running as Eclipse Plugin
+#### Instalation
+* Open Palladio Bench
+* Choose in the menue: Help ==> Install new Software
+* Enter update site https://se4.informatik.uni-wuerzburg.de/pmx-dml/downloads/snapshot/
+* Click Select All button, click next, click next, aggree to license, click finish
+* Wait for installation (aggree to install unsigned content)
+* Aggree to restart eclipse
+* you installed it ;-)
+
+#### Usage
+* Choose in the menue: File ==> Import ==> PMX
+* Follow the PMX dialog instructions and select input and output directory (hint: you may choose to automatically create a project in the current workspace for output directory)
+
+### Running as Docker
+* PMX can be executed as a [contiuous server](https://se3.informatik.uni-wuerzburg.de/descartes/pmx-pcm/tree/master/tools.descartes.pmx.pcm.docker) providing a REST api.
+
+
+
+## License
+PCM : Performance Model eXtractor
+
+(c) Copyright 2014-2015, by Juergen Walter and Contributors.
+
+Project Info:   http://descartes.tools/pmx
+
+All rights reserved. This software is made available under the terms of the
+Eclipse Public License (EPL) v1.0 as published by the Eclipse Foundation
+http://www.eclipse.org/legal/epl-v10.html
\ No newline at end of file