From 6256104efe85687a2be8c8b16753d1651d7b2227 Mon Sep 17 00:00:00 2001 From: Maximilian Kodetzki <58151492+Kodde2011@users.noreply.github.com> Date: Thu, 9 Nov 2023 14:11:27 +0100 Subject: [PATCH] Update README.md --- README.md | 39 +++++++++++++++------------------------ 1 file changed, 15 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index eaadf59a9..4ed7be4d4 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,19 @@ -# [CorC](https://github.com/TUBS-ISF/CorC/wiki) +# [CorC](https://github.com/KIT-TVA/CorC/wiki) Tool Support for Correctness-by-Construction -# [C-CorC](https://github.com/TUBS-ISF/CorC/wiki/CorC-for-Information-Flow) +# [C-CorC](https://github.com/KIT-TVA/CorC/wiki/CorC-for-Information-Flow) Tool Support for Confidentiality- and Correctness-by-Construction -# CorC Project Setup Guide & Case Study Introduction (2022-09-27) +# CorC Project Setup Guide & Case Study Introduction (2023-11-09) Installation guide for plugins and properties for **development with CorC** with introduction of case studies. ## Java Version * Please use [**JDK 16**](https://www.oracle.com/java/technologies/javase/jdk16-archive-downloads.html). CorC may not work out of the box with newer versions. ## Setup -### **Eclipse Settings** -Before installing any plugins, navigate to - - - *Preferences > Install/Update > Available Software Sites* - -and disable the following entries -- *Latest Eclipse IDE Packages Release* -- *Latest Eclipse Simultaneous Release* - ### **Plugins and Software** -* **Eclipse** Install [Eclipse Modelling Tools](https://www.eclipse.org/downloads/packages/release/2021-06/r). Please use version 2021-06 (Eclipse 4.20.0). CorC may not work correctly with newer versions. +* **Eclipse** Install [Eclipse Modelling Tools](https://www.eclipse.org/downloads/packages/release/2023-09/r). Please use version 2023-09 (Eclipse 4.29.0). CorC may not work correctly with other versions. +* Before installing any plugins, navigate to *Preferences > Install/Update > Available Software Sites* and disable *Latest Eclipse IDE Packages Release* and *Latest Eclipse Simultaneous Release*. * **Graphiti** Install Graphiti using the update site https://download.eclipse.org/graphiti/updates/0.18.0/ -* **KeY** Install KeY using the update site https://formal.iti.kit.edu/key/download/releases/2.6/eclipse/ -* **Jamopp** Install Jamopp using the update site http://update.jamopp.org/release +* **KeY** Install KeY using the update site https://formal.iti.kit.edu/key/download/releases/2.6/eclipse/ (disable *Group items* to show available plugins, install all) * **Xtext** Available in [Eclipse Marketplace](https://marketplace.eclipse.org/content/eclipse-xtext) * **FeatureIDE** Available in [Eclipse Marketplace](https://marketplace.eclipse.org/content/featureide) * **Mylyn** Available in [Eclipse Marketplace](https://marketplace.eclipse.org/content/mylyn) (Mylyn 3.23) @@ -31,24 +22,24 @@ and disable the following entries ## Properties & Initialisation 1. Checkout master from https://github.com/TUBS-ISF/CorC.git -2. Open the following packages in Eclipse Modelling Tools: -* de.tu_bs.cs.isf.cbc.cbcclass.model -* de.tu_bs.cs.isf.cbc.statistics -* de.tu_bs.cs.isf.cbc.statistics.ui -* de.tu_bs.cs.isf.commands.toolbar +2. Install **JaMoPP** using the two plugins of the tool.update package from Git (disable *Group items* to show available plugins) +3. Open the following packages in Eclipse Modelling Tools: * de.tu-bs.cs.isf.cbc.model * de.tu-bs.cs.isf.cbc.tool * de.tu-bs.cs.isf.cbc.util * de.tu-bs.cs.isf.cbcclass.tool * de.tu-bs.cs.isf.wizards +* de.tu_bs.cs.isf.cbc.parser +* de.tu_bs.cs.isf.cbc.statistics +* de.tu_bs.cs.isf.cbc.statistics.ui +* de.tu_bs.cs.isf.commands.toolbar +* de.tu_bs.cs.isf.lattice -3. Disable warnings for circular dependencies: -Window -> Preferences -> Java -> Compiler -> Building -> Build path problems -> Circular dependencies -> Warning -4. Generate model/edit/editor: Open model/.genmodel of cbcmodel, cbcclassmodel, and statistics and rightclick on Generate ... If multiple referencing errors occur, uninstall Jamopp Plugins via Window -> Preferences -> Install/Update -> Uninstall or update. After uninstalling, reinstall via Marketplace. +4. Generate model/edit/editor: Open model/genmodel.genmodel of package cbc.model and model/cbcstatistics.genmodel of package cbc.statistics and rightclick on Generate model/edit/editor. If multiple resolving errors occur, uninstall JaMoPP Plugins via Window -> Preferences -> Install/Update -> Uninstall or update. After uninstalling, reinstall as described above. 5. Select any package and run project as Eclipse Application. ## Examples and Case Studies -We provide different examples and case studies to explore VarCorC! +We provide different examples and case studies to explore CorC! ### Examples Create CorC-examples via File -> New -> Other... -> CorC -> CorC Examples -> Select examples you want to create. ### Case studies