Document the size of the terminal window

[coffee/main.git] / README.md

diff --git a/README.md b/README.md
index 67c43e3261b0d2eaef0fb5a088512866e769d036..718d2faf4dea1f0f5e48ae75e74b29ea0aa029d1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,12 +5,17 @@ terminal. Fetch it with:
 
        git submodule update --init
 
-The `coffee-flask`  directory contains the server application, which
-runs on [rtime](https://rtime.felk.cvut.cz/coffee) server.
-
-`terminal` directory is the code running on the terminal. It is a
-standard buildroot distribution. The most important piece of code here
-is the `mtaio` application from `terminal/src/mt-apps`.
+The [`coffee-flask`](coffee-flask.git) directory contains the server
+application, which runs on [rtime](https://rtime.felk.cvut.cz/coffee)
+server.
+
+`terminal` directory contains the code running on the terminal. It is
+based on a standard [buildroot](https://buildroot.org/) distribution.
+The most important piece of code here is the `mtaio` application from
+[`terminal/src/mt-apps`](./mt-apps.git), which contains the web server
+powering the GUI of the terminal – a web browser. Among other things,
+it informs the browser about physical events captured by the terminal
+from the card reader and coffee machine buttons.
 
 A more detailed documentation is available in [Jiří Matěják's Master
 thesis](https://dspace.cvut.cz/handle/10467/76276).
@@ -44,6 +49,8 @@ Then compile and run all the software components:
    Numbers are cards of different users, letters A through F are
    different coffee machine buttons.
 
+The size of the terminal window is 960×560 px.
+
 ### Submitting patches
 
 Send patches by email (preferably with [git send-email][]) to