README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..f843bbf
--- /dev/null
+++ b/README
@@ -0,0 +1,42 @@
+== ASM ==
+- befindet sich in 3a_asm/
+- requirements: ghc und zsh
+- build: cd 3a_asm; make
+
+== SIM ==
+- befindet sich in 3b_sim/
+- requirements: g++, ... TODO
+- build: cd 3b_sim; make
+
+== DTPROG ==
+- was: programmer ueber UART mittels BootROM
+- befindet sich in tools/
+- requirements: python2
+
+== PROGS ==
+- befindet sich in progs/
+- mit "make build" kann man ASM und SIM builden
+- "make name.dthex" ruft den ASM mit "name.s" auf. Das Ergebnis befindet sich in
+  "name.dthex".
+- "make name.sim" ruft den SIM mit dem Programm auf ("help" im SIM fuer
+  Erklaerung)
+- "make name.prog" flasht das Programm per DTPROG auf die CPU
+- ACHTUNG: Baudrate und Device muss ggf. im progs/Makefile angepasst werden!
+  Beim Quartus Projekt (siehe unten) ist eine Baudrate von 9600 eingestellt.
+
+== HARDWARE DESIGN ==
+- source befindet sich in cpu/src/
+- passendes Quartus Projekt fuer die Cyclons im TILAB in dt/
+- Image muss mit USBRunner auf das FPGA geladen werden
+- Hinweis: fertiges Image liegt bereits im Rootverzeichnis
+  ("tilab_bootrom_abgabe.rbf").
+- Hinweis: Nach dem Flashen der CPU sollte die LED leuchten. LED an bedeutet,
+  die CPU befindet sich im BootROM.
+- Hinweis: Linker Button ist der "Hard-Reset" (return to BootROM)
+- Hinweis: Rechter Button ist der "Soft-Reset" (Springe zum Start des Programms
+  im Instruktion-RAM)
+
+
+Bei Fragen/Unklarheiten/Feedback/whatever kannst du uns gerne kontaktieren!
+
+Have fun.