]> rtime.felk.cvut.cz Git - coffee/main.git/commitdiff
Extend README
authorMichal Sojka <michal.sojka@cvut.cz>
Wed, 19 Aug 2020 17:30:24 +0000 (19:30 +0200)
committerMichal Sojka <michal.sojka@cvut.cz>
Thu, 20 Aug 2020 09:50:45 +0000 (11:50 +0200)
README.md

index 67c43e3261b0d2eaef0fb5a088512866e769d036..569a926de0ade1ad1799b0cb1ce7b64a5cc386a7 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).