From 40fb39328f8b3ca913ddf30ee51a479ccde74176 Mon Sep 17 00:00:00 2001 From: Markus Hamann <markus.hamann1@tu-dresden.de> Date: Mon, 24 Jun 2024 12:25:44 +0200 Subject: [PATCH] Add first version for ReadMe --- README.md | 117 ++++++++++++++++++++++-------------------------------- 1 file changed, 48 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index ace75df..7a72b55 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,72 @@ # statemachine-EclipsePlugIn +Dieses Repository bietet eine Beispiel Implementierung einer model-getriebenen Softwareentwicklungs-Pipeline (MDSE/MDSD). +Die verwendete Technologie ist EMF mit den Plug-Ins Xtext, Epsilon, und Sirius. +Die verwendete Entwicklungsumgebung ist Eclipse mit dem *Eclipse Modeling Tools*. +Die ausgegeben Artefakte sind Eclipse Plug-Ins. -## Getting started -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +## Vorbereitung -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +1. Installieren Sie die [*Eclipse Modeling Tools*](https://www.eclipse.org/downloads/packages/release/2024-06/r/eclipse-modeling-tools). Die EMT sind eine vorbereitete Eclipse Instanz mit allen grundlegenden Plugins und ist als standalone Version für alle Betriebssysteme verfügbar. +2. Installieren Sie die folgenden beiden Plugins in der entpacken, gestarteten Eclipse Instanz mittels `Help` → `Eclipse Marketplace`. + - Eclipse Xtext + - Epsilon + - Sirius + Alle Plugins können in der aktuellsten Version im kompletten Umfang installiert werden. +3. Unter folgenden Links können Sie die Dokumentationen finden, welche Sie zum Workshop bereit halten sollten + - [Xtext](https://eclipse.dev/Xtext/documentation/301_grammarlanguage.html) + - [Epsilon (EOL, EVL, EXL/EGL)](https://eclipse.dev/epsilon/doc/eol/) + - [Sirius](https://wiki.eclipse.org/Sirius/Tutorials/StarterTutorial) -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://git-st.inf.tu-dresden.de/open-teaching-resources/model-driven-software-development/statemachine-eclipseplugin.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://git-st.inf.tu-dresden.de/open-teaching-resources/model-driven-software-development/statemachine-eclipseplugin/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README +## Installation -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. +Alle Projekte können in der IDE mittels `Import...` → `Projects from Folder ...` in den Model Explorer (links) geladen werden. -## Suggestions for a good README +Importieren Sie in den direkten Workspace: -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. +- Das State Machine Metamodell: + - `./metamodel/swt.most.statemachine` + - `./metamodel/swt.most.statemachine.edit` + - `./metamodel/swt.most.statemachine.editor` -## Name -Choose a self-explaining name for your project. +- Das PetriNet Metamodell (wenn Model-to-Model Transformation verwendet werden soll): + - `./metamodel/swt.most.petrinet` + - `./metamodel/swt.most.petrinet.edit` + - `./metamodel/swt.most.petrinet.editor` -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. +- Die textuelle DSL, wenn diese für die State Machine verwendet werden soll + - `./domain_specific_language/textual/swt.most.statemachine.xtext` -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. +Mittels Rechtsklick auf eines der Projekte und `Run As...` → `Eclipse Application` wird ein Runtime-Workspace gestartet. -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. +Importieren Sie in den direkten Runtime-Workspace: -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. +- Die Graphische DSL der State Machine (wenn keine textuelle DSL für die State Machine verwendet wird): + - `./domain_specific_language/graphical/swt.most.statemachine.sirius` +- Die Graphische DSL des PetriNets (wenn das PetriNet Metamodell verwendet wird): + - `./domain_specific_language/graphical/swt.most.statemachine.sirius` -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. +- Der Transformator der State Machine (benötigt beide Metamodelle) + - `./model2model/swt.most.statemachine.to.petrinet.etl` -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. +- Der Validator der State Machine + - `./model2model/swt.most.statemachine.validation.evl` -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +- Der Java Code Generator (Model-to-Text) der StateMachine + - `./model2text/swt.most.statemachine.to.java.egl` -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +## Beispiele -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +Alle Teile der MDSD-Pipeline können einzeln oder in Reihe verwendet werden. Mur sollte sich auf eine DSL Art (graphisch oder textuell) geeinigt werden. -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +Für jeden Teil liegt ein Beispielprojekt bei. Normalerweise liegen die Beispiele im XMI Format bereit. Sollte die textuelle DSL Verwendet werden, können die textuellen Modelle automatisch mit den vorliegenden Transformatoren, Validatoren und Model-to-Text-Generatoren verwendet werden, solange die DSL im direkten Workspace geladen ist. Bitte verwenden Sie dann die Beispielmodelle der textuellen DSL. -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +## Verwendung -## License -For open source projects, say how it is licensed. +- Für Epsilon Applikationen liegen `.launch` Konfigurationen bei die mit `Run As ...` gestartet werden können. (Wenn eine textuelle DSL verwendet wir , müssen die XMI-basierten Modelle zuvor durch textuelle Modelle ausgetauscht werden) + - Ansonsten kann über `Run As ...` eine neue Konfiguration angelegt werden. Hier die jeweilige script Datei als `source` auswählen und unter `models` mittels `Add...` ein EMF Modell mit Namen `source` und beim Transformator ein leeres EMF Modell mit Namen `target` hinzufügen. (für beide muss über `Model File` eine Datei ausgewählt werden.) +- Bei Sirius basierten DSLs können die Editoren durch die `.aird` Datei geöffnet werden (Datei im Explorer aufklappen) oder durch Rechtsklick auf das Projekt mittels `create Representation` erstellt werden. -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +Für weitere Hinweise zum Ausführen schauen Sie sich bitte die jeweilige Dokumentation des Plugins an. \ No newline at end of file -- GitLab