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
  36 <details><summary>
  37 ### Szenarios
  38 </summary><p>
  39 #### 1.
  40 </p></details>
  41
  42 ## Technologie-Stack
  43 *   Git (anscheinend über Gitlab)
  44 *   Eclipse RCP
  45     -  (noch zu testen)
  46 *   Java
  47     -   Version 8?
  48     -   Version 10?
  49     -   Version 12?
  50 *   Bibliotheken
  51     -   Lombok? [https://projectlombok.org/features/all](https://projectlombok.org/features/all)
  52         Sauberer und sicherer Code; aber zusätzliche Dep.
  53     -   JUnit 5.4.x ? AssertJ? [http://joel-costigliola.github.io/assertj/index.html](http://joel-costigliola.github.io/assertj/index.html)
  54     - (Apache Commons?)
  55     Sehr weit verbreitete und gut designte & getestete Lib;
  56     aber zusätzliche Dep.
  57     - Sonstiges? Logging? Log4j
  58 -   Automatischer Build mit Maven? Wohl eher nicht, wegen ERPC Build
  59
  60 ## Meilensteine
  61
  62 ## Außenwirkung
  63 ### Name, Abkürzung
  64 ### Signet, Logo
  65 ### Beschreibung
  66
  67 ## Sonstiges
  68 ### Nützliche Links
  69 - [https://wiki.eclipse.org/Rich_Client_Platform](https://wiki.eclipse.org/Rich_Client_Platform) -Links
  70 - [https://wiki.eclipse.org/User_Interface_Guidelines](https://wiki.eclipse.org/User_Interface_Guidelines) - etwas alt, aber nützlich
  71 - [https://download.eclipse.org/eclipse/downloads/](https://download.eclipse.org/eclipse/downloads/) - Eclipse Project
  72 - [https://www.vogella.com/tutorials/EclipseRCP/article.html](https://www.vogella.com/tutorials/EclipseRCP/article.html) - **Eclipse RPC Tutorial**
  73 - [https://github.com/eclipse/gef/wiki](https://github.com/eclipse/gef/wiki) - **Wiki für das Grafikframework**
  74 - [https://github.com/eclipse/MaisiKoleni/Am2900ME](https://github.com/eclipse/MaisiKoleni/Am2900ME)
  75
  76 ### Rechtliches
  77 <details><summary>MIT Lizenz? - [https://choosealicense.com/licenses/mit/](https://choosealicense.com/licenses/mit/)</summary><p>
  78
  79 >MIT License
  80 >
  81 >Copyright (c) 2019 Christian Femers, Daniel Kirschten, Fabian Stemmler
  82 >
  83 >
  84 >
  85 >Permission is hereby granted, free of charge, to any person obtaining a copy
  86 >of this software and associated documentation files (the "Software"), to deal
  87 >in the Software without restriction, including without limitation the rights
  88 >to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  89 >copies of the Software, and to permit persons to whom the Software is
  90 >furnished to do so, subject to the following conditions:
  91 >
  92 >The above copyright notice and this permission notice shall be included in all
  93 >copies or substantial portions of the Software.
  94 >
  95 >THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  96 >IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  97 >FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  98 >AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  99 >LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 100 >OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 101 >SOFTWARE.
 102
 103 </p></details>
 104 Muss ggf. Eclipse Public License verwendet werden wegen Copyleft?