REQUIREMENTS.MD

   1 # Rechnerarchitektur GP 2019
   2 #### Modularer Grafischer Schaltkreis Simulator (für die MI-Maschine)
   3
   4 ## Anforderungen
   5
   6 ### Pflichtfeatures
   7 1.  Emulation der MI-Maschine (siehe Am2900ME)
   8 2.  Visualisierung der MI-Maschine sehr ähnlich dem Bild der VL
   9 3.  sehr gute Website, Dokumentation, Hilfe aus dem Kontextmenü heraus
  10 4.  Hilfreiche Fehlermeldungen, Warnungen bei gefährlichen Operationen
  11     für uns/Entwickler: gutes Loggen, Absturzberichte
  12 5.  Immer hilfreiche Tooltips zu fast allem.
  13
  14
  15 ### Sollte möglich sein
  16 1.  Export der Ansicht
  17 2.  Sicht des Assemblerprogrammierers, spezifizieren einer ISA und Nutzung
  18 3.  Farben, Schriftgröße & Co. einstellbar (für Präsentation, Hell/Dunkel, Farbenblind/…)
  19 4.  Entwurf eines Schaltkreises mit einem Editor
  20 5.  Sprache ändern (für nicht Muttersprachler, internat. Potenzial, Erweiterungsmögl.)
  21 6.  Sehr einfache Installation (Eclipse Marketplace)
  22 7.  Editor sollte tooltip Einstellung erlauben
  23 8.  Rückgängig
  24
  25
  26 ### Wunschfeatures
  27 1.  Debuggen im Sinne von Breakpoints & Co.
  28 2.  interaktives Tutorial in der GUI
  29 3.  Zurückspulen der Simulation / Zeitleiste
  30 4.  Wiederherstellungspunkt (Status)
  31
  32 ### Weiterführende Ideen
  33 1.  x86 Modell
  34 2.  ARM Modell
  35 3.  Signalgraphen
  36
  37 ### Szenarios
  38 <details><summary>
  39
  40 __*Alle Szenarios anzeigen*__
  41
  42 </summary><p>
  43
  44 #### 01. Installation
  45 Das Programm lässt sich entweder über den Eclipse Marketplace einfach installieren (oder als Eclipse Projekt) oder **als eigenes Eclipse RPC Projekt direkt herunterladen (ggf. entpacken) und starten.**<sup>[A]</sup> Das Programm / Plugin lässt sich auf Windows (7+), MacOS und Linux ausführen; alle verbreitete Hardware nach 2010 mit 64 Bit OS sollte funktionieren.<sup>[B]</sup> Es muss auf den Rechnern in den TUM Rechnerhallen funktionieren.<sup>[C]</sup>
  46
  47 #### 02. Deinstallation
  48 Das Programm muss sich ohne nennenswerten Aufwand oder Kentnisse vom Benutzer rückstandslos entfernen lassen.<sup>[A]</sup>
  49
  50 #### 03. Programmstart
  51 Das Programm bzw. Plugin startet schnell (unter 10 sec.; besser unter 5 sec).<sup>[A]</sup> Bei dem ersten Programmstart ist ein Willkommensfenster zu sehen, das auf erklärende Resourcen verweist, den Nutzer grüßt und ggf. auf die (Sprach-)Einstellungen hinweist.<sup>[B]</sup> Es wird bestenfalls auf ein Beispielprojekt verwiesen (kann erstellt werden?) um dem Nutzer zu ermöglichen, sich damit vertraut zu machen.<sup>[C]</sup> Ein schnell Link zum Erstellen eines neuen Projekts/Simulation/... wird angezeigt.<sup>[D]</sup>
  52
  53 #### 04. Programmende
  54 Sollten bei Beenden des Programms oder Programmabsturz nicht persistierte Daten vorliegen, muss dafür gesorgt werden, dass diese nicht verloren gehen.<sup>[A]</sup> Enweder durch einen Dialog<sup>[B]</sup>, oder durch erzeugte Recovery-Dateien<sup>[C]</sup>. Bei Absturz des Programms wird eine passende und aufschlussreiche Fehlermeldung angezeigt, bestenfalls mit Link zu einer Report-Möglichkeit.<sup>[D]</sup>
  55
  56 #### 05. Einstellungen
  57 Die Hauptextfarbe und Schriftgröße muss einstellbar sein<sup>[A]</sup>, besser noch Hintergrund- und Markierungsfarben und Schriftstil.<sup>[B]</sup> Die Einstellung der Sprache muss möglich sein.<sup>[C]</sup>
  58
  59 #### 06. Einstieg
  60 Das Einstiegsprojekt zeigt zu Beginn die passende Ansicht an, die Mikroprogrammierung ist wie bei dem Am2900ME ungehindert möglich.<sup>[A]</sup> Bestenfalls ist dieses beim (erstmaligen) Start direkt geöffnet.<sup>[B]</sup> Wichtige Fenster (v.a. die grafische Darstellung) sind direkt sichtbar, oder zumindest in einem Tab geöffnet (müssen nicht gesucht werden).<sup>[C]</sup>
  61
  62 #### 07. Nutzung der Visualisierung
  63 Die Visualisierung soll möglichst der Vorlesung entsprechen.<sup>[A]</sup> Sie lässt sich transformieren (z.B. Zoom mit dem Mausrad, Verschieben mit Mausklick oder Mausklick und Alt) und wieder zurücksetzen.<sup>[B]</sup>
  64
  65 #### 08. Hilfestellung
  66 Mit dem Produkt wird eine offline-Dokumentation mitgeliefert. (bestenfalls DE und EN)<sup>[A]</sup> Mit Rechtsklick lässt sich über ein Kontextmenü der Teil der Dokumentation öffnen, der das angeklickte und seine Funktion beschreibt. Dies sollte mit fast allem möglich sein.<sup>[B]</sup> Bleibt man mit der Maus länger über einem GUI-Bestandteil, wird eine kurze Beschreibung/Hilfe dazu angezeigt (Tooltip).<sup>[C]</sup>
  67
  68 #### Fügt hier eure eigenen dazu, fortlaufend nummeriert und ggf. mit <sup>[A,B,C,..]</sup> genauer spezifiziert.
  69
  70 </p></details>
  71
  72 ## Technologie-Stack
  73 *   Git (anscheinend über Gitlab)
  74 *   Eclipse RCP
  75     -  (noch zu testen)
  76 *   Java
  77     -   Version 8?
  78     -   Version 10?
  79     -   Version 12?
  80 *   Bibliotheken
  81     -   Lombok? [https://projectlombok.org/features/all](https://projectlombok.org/features/all)
  82         Sauberer und sicherer Code; aber zusätzliche Dep.
  83     -   JUnit 5.4.x ? AssertJ? [http://joel-costigliola.github.io/assertj/index.html](http://joel-costigliola.github.io/assertj/index.html)
  84     - (Apache Commons?)
  85     Sehr weit verbreitete und gut designte & getestete Lib;
  86     aber zusätzliche Dep.
  87     - Sonstiges? Logging? Log4j
  88 -   Automatischer Build mit Maven? Wohl eher nicht, wegen ERPC Build
  89
  90 ## Meilensteine
  91
  92 ## Außenwirkung
  93 ### Name, Abkürzung
  94 ### Signet, Logo
  95 ### Beschreibung
  96
  97 ## Sonstiges
  98 ### Nützliche Links
  99 - [https://wiki.eclipse.org/Rich_Client_Platform](https://wiki.eclipse.org/Rich_Client_Platform) -Links
 100 - [https://wiki.eclipse.org/User_Interface_Guidelines](https://wiki.eclipse.org/User_Interface_Guidelines) - etwas alt, aber nützlich
 101 - [https://download.eclipse.org/eclipse/downloads/](https://download.eclipse.org/eclipse/downloads/) - Eclipse Project
 102 - [https://www.vogella.com/tutorials/EclipseRCP/article.html](https://www.vogella.com/tutorials/EclipseRCP/article.html) - **Eclipse RPC Tutorial**
 103 - [https://github.com/eclipse/gef/wiki](https://github.com/eclipse/gef/wiki) - **Wiki für das Grafikframework**
 104 - [https://github.com/eclipse/MaisiKoleni/Am2900ME](https://github.com/eclipse/MaisiKoleni/Am2900ME)
 105
 106 ### Rechtliches
 107 <details><summary>MIT Lizenz? - [https://choosealicense.com/licenses/mit/](https://choosealicense.com/licenses/mit/)</summary><p>
 108
 109 >MIT License
 110 >
 111 >Copyright (c) 2019 Christian Femers, Daniel Kirschten, Fabian Stemmler
 112 >
 113 >
 114 >
 115 >Permission is hereby granted, free of charge, to any person obtaining a copy
 116 >of this software and associated documentation files (the "Software"), to deal
 117 >in the Software without restriction, including without limitation the rights
 118 >to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 119 >copies of the Software, and to permit persons to whom the Software is
 120 >furnished to do so, subject to the following conditions:
 121 >
 122 >The above copyright notice and this permission notice shall be included in all
 123 >copies or substantial portions of the Software.
 124 >
 125 >THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 126 >IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 127 >FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 128 >AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 129 >LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 130 >OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 131 >SOFTWARE.
 132
 133 </p></details>
 134 Muss ggf. Eclipse Public License verwendet werden wegen Copyleft?