documentation

README.md

@@ -1,6 +1,8 @@
 # HintCO
 
-This framework is a automated co-simulation program which is based on hints. Co-simulation user define some hints in the framework, then framework automatically try to find best master algorithm in order to satisfy user hints. It runs numerous simulation and check the results and use the past results to improve next simulation with new master algorithm  
+This framework is a automated co-simulation program which is based on hints.
+The co-simulation user define some hints in the framework, then the framework automatically try to find best master algorithm in order to satisfy user hints.
+It runs numerous simulations, using the past results to improve next simulation with new master algorithm.  
 
 ## Getting Started
 
@@ -8,24 +10,30 @@ These instructions will get you a copy of the project up and running on your loc
 
 ### Prerequisites
 
-Windows platform.
+Windows/Linux platform.
 
 ### Installing
 
-In order to setup the frame work, you need follow these steps:
+In order to setup the framework, you need follow these steps:
 
-1. Install Eclipse IDE for RCP and RAP Developers 
+1. Install Eclipse IDE for RCP and RAP Developers
 	Version: Photon Release (4.8.0)
+1. Install Xtend (Version 2.16)
+	Using Install new software in Help tab of eclipse
+1. Install Xcore (Version 1.6)
+	Using Install new software in Help tab of eclipse
+1. [Optional] Install Maven (Version 3.6)
 
-2. Install Xtend (Version 2.16)
-	Using Install new software in Help tab
-	
-3. Install Xcore 
-	Using Install new software in Help tab
-	
-4. Restart Eclipse
+### Building and Testing
 
-After following those steps, check dependencies to make sure that there is no error. 
+The build can be done in both Eclipse and Maven.
+Likewise, tests are run using either Eclipse (Junit 4) or Maven.
+We recommend running the Eclipse plugin tests.
+
+### Exporting an Application
+
+The binaries are exported as an Eclipse RCP Application.
+The file `HintCO.product` contains all the information.
 
 ## Contributing
 
@@ -33,7 +41,7 @@ Please read [CONTRIBUTING.md](https://msdl.uantwerpen.be/git/claudio/HintCO/src/
 
 ## Versioning
 
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://msdl.uantwerpen.be/git/claudio/HintCO/tags). 
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://msdl.uantwerpen.be/git/claudio/HintCO/tags).
 
 ## License