瀏覽代碼

Add plugin exporting instructions to README.

bentleyjoakes 6 年之前
父節點
當前提交
3b390b44ec
共有 1 個文件被更改,包括 23 次插入15 次删除
  1. 23 15
      README.md

+ 23 - 15
README.md

@@ -8,20 +8,20 @@ It runs numerous simulations, using the past results to improve the next simulat
 
 The latest precompiled binaries for Windows are available for download in the releases.
 
-For Linux and macOS platforms, see [Getting Started in Development](#Getting-Started-in-Development).
+For Linux and Windows platforms, see [Getting Started in Development](#Getting-Started-in-Development).
 
 ## Usage Instructions
 
 There are two main tasks in running a co-simulation with HintCO:
 
-1. Configure a co-simulation scenario file. This is an xml file that can be easily edited with Eclipse and the editor plugin shipped with HintCO.
+1. Configure a co-simulation scenario file. This is an XML file that can be easily edited with Eclipse and the editor plugin shipped with HintCO.
 2. Compute the co-simulation results.
 
 #### Configuring Co-simulation Scenarios
 
-Co-simulation scenario are just xml files. See [watertanks.xmi](HintCOEngine/examples/watertanks.xmi) for an example.
+Co-simulation scenario are just XML files. See [watertanks.xmi](HintCOEngine/examples/watertanks.xmi) for an example.
 
-HintCO provides EMF Editor Plugins to edit such files. To use them, setup the development environment (instruction below), and drop the `HintCO.edit_*.jar` and `HintCO.editor_*.jar` files into the `plugins` folder of an  eclipse modelling tools distribution (Photon Release 4.8.0).
+HintCO provides EMF Editor Plugins to edit such files. To use them, setup the development environment and export the editor jars (see the instructions below). Then, place the exported `HintCO.edit_*.jar` and `HintCO.editor_*.jar` files into the `plugins` folder of an Eclipse Modelling Tools distribution (Photon Release 4.8.0).
 
 #### Running Co-simulations
 
@@ -59,26 +59,34 @@ Windows/Linux platform.
 
 To setup the framework, you need follow these steps:
 
-1. Install Eclipse IDE for RCP and RAP Developers.
+1. Install Eclipse ModelingTools.
 	Version: Photon Release (4.8.0)
-1. Install Xtend (Version 2.16 or 2.17).
-	Using Install new software in Help tab of eclipse.
-1. Install Xcore (Version 1.6).
-	Using Install new software in Help tab of eclipse.
-	Xcore will be part of the Xtend.
-	The Xtend repository should be available in the "Work with" dropdown.
-	Either enter "Xcore" in the filter field or locate "Modeling → EMF - Eclipse Modeling Framework Xcore SDK" in the content and check mark it.
+	For the below dependencies, use 'Install new software' in Help tab of eclipse.
+2. Install "Modeling → EMF - Eclipse Modeling Framework Xcore SDK"
+3. Install "Modeling → Xpand SDK"
+4. Install "Modeling → Xtext Complete SDK"
 
 ### Exporting the HintCO Binary
 
 Exporting the HintCO binary is performed in Eclipse.
 
-1. Use Eclipse to open the [HintCO.product](HintCOEngine/HintCO.product) file.
+1. Use Eclipse to open the [HintCOEngine/HintCO.product](HintCOEngine/HintCO.product) file.
 2. Ensure that the *Overview* tab is selected.
 3. On the right-hand side of the tab, under the *Exporting* headline, click the *Eclipse Product export wizard* link.
 4. Set the destination directory where the binary will be exported to.
 5. Select *Finish*.
 
+### Exporting the Editor Plugins
+
+Exporting the editor plugins is performed in Eclipse.
+
+1. Use Eclipse to open the [HintConfiguration.edit/plugin.xml](HintConfiguration.edit/plugin.xml) file.
+2. Ensure that the *Overview* tab is selected.
+3. On the right-hand side of the tab, under the *Exporting* headline and on the line starting with *4.*, click the *Export Wizard* link.
+4. Set the destination directory where the plugin jar will be exported to.
+5. Select *Finish*.
+6. Repeat the above steps for the [HintConfiguration.editor/plugin.xml](HintConfiguration.editor/plugin.xml) file.
+
 ## Contributing
 
 Please read [CONTRIBUTING.md](https://msdl.uantwerpen.be/git/claudio/HintCO/src/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
@@ -93,7 +101,7 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) f
 
 ## Paper
 
-If you use the HintCO, please cite our paper.
+If you use HintCO, please cite our paper.
 
 Gomes, C.; Oakes, B.; Moradi, M.; Gámiz, A.; Mendo, J.; Dutré, S.; Denil, J. and Vangheluwe, H. (2019). HintCO – Hint-based Configuration of Co-simulations.In Proceedings of the 9th International Conference on Simulation and Modeling Methodologies, Technologies and Applications - Volume 1: SIMULTECH, ISBN 978-989-758-381-0, pages 57-68. DOI: 10.5220/0007830000570068.
 ```
@@ -108,4 +116,4 @@ organization={INSTICC},
 doi={10.5220/0007830000570068},
 isbn={978-989-758-381-0},
 }
-```
+```