Make it easier to hack on the code and document it

[coffee/main.git] / README.md

diff --git a/README.md b/README.md
index 0719f11057ddb4c7eacd47842e260835d35757e0..c79059b5ebb2800bc903434ee24f6c1c3f1fe749 100644 (file)
--- a/README.md
+++ b/README.md
@@ -23,3 +23,23 @@ access to the database. For example, the whole database can be dumped
 with this command:
 
     sqlite3 /home/coffee/coffee-flask/coffee.db .dump
+
+## Hacking on the code
+
+To improve the terminal, you can run all the relevant code on your
+Linux computer.
+
+First install all prerequisities:
+
+    apt install python3-flask libev-dev cmake
+       pip3 install flask_cors
+
+Then compile and run all the software components:
+
+1. Compile _mtaio_ simulator: `make -C terminal/src/mt-apps SIM=1`
+2. Run mtaio: `cd terminal/src/mt-apps && ./build/mtaio`
+3. Run the server application: `cd coffee-flask && FLASK_APP=app flask run`
+4. Point your web browser to http://localhost:8080/
+5. Pressing keys in _mtaio_ window simulates various activities.
+   Numbers are cards of different users, letters A through F are
+   different coffee machine buttons.