1 files changed, 28 insertions, 0 deletions

diff --git a/qt-quick/README.md b/qt-quick/README.md
new file mode 100644
index 0000000..54c4136
--- /dev/null
+++ b/qt-quick/README.md
@@ -0,0 +1,28 @@
+# QT-quick implementation of a nissy UI
+
+This is a UI for nissy written using
+[QT Quick](https://doc.qt.io/qt-6/qtquick-index.html).
+
+It has been tested only on Linux with QT 6.9.
+Building requires CMake.
+
+To build this project, run
+
+```
+make
+```
+
+To run it you can use
+
+```
+./run
+``
+
+or
+
+```
+make run
+```
+
+The latter command is going to build the project (if has not already
+been built) and run it with some debug options enabled.