]> rtime.felk.cvut.cz Git - coffee/main.git/commitdiff
Add README
authorMichal Sojka <michal.sojka@cvut.cz>
Tue, 7 Aug 2018 13:34:45 +0000 (15:34 +0200)
committerMichal Sojka <michal.sojka@cvut.cz>
Tue, 7 Aug 2018 13:34:45 +0000 (15:34 +0200)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..86f3392
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# IID Coffee Terminal
+
+This repo contains git submodules with all source code of this coffee
+terminal. Fetch it with:
+
+       git submodule update --init
+
+The `coffee-flask`  directory contains the server application, which
+runs on rtime.felk.cvut.cz server.
+
+`terminal` directory is the code running on the terminal. It is a
+standard buildroot distribution. The most importat piece of code here
+is the `mtaio` application from `terminal/src/mt-apps`.
+
+A more detailed documentation is available in [Jiří Matěják's Master
+thesis](https://dspace.cvut.cz/handle/10467/76276).