summaryrefslogtreecommitdiffstats
path: root/gui/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'gui/README.md')
-rw-r--r--gui/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/gui/README.md b/gui/README.md
new file mode 100644
index 0000000..985efa5
--- /dev/null
+++ b/gui/README.md
@@ -0,0 +1,29 @@
+The ODR-DabMux Web Management GUI
+=================================
+
+The whole world has repeatedly been asking for a graphical administration
+console for the ODR-mmbTools. I give in now, and start working on this
+web-based GUI.
+
+In the current state, it can display part of the configuration of a running
+ODR-DabMux in your browser. It doesn't seem like much, but you *will* be
+impressed.
+
+Usage
+-----
+
+Launch ODR-DabMux with your preferred multiplex, and enable the statsserver
+(which will soon be renamed) in the configuration file to port 12720.
+
+Start the gui/odr-dabmux-gui.py script on the same machine
+
+Connect to http://localhost:8000
+
+Admire the fabulously well-designed presentation of the configuration.
+
+Expect more features to come: Better design; integrated statistics, dynamically
+updated information, configuration upload and download, less ridiculous README,
+and much more. We can even start dreaming about live multiplex reconfiguration.
+
+2015-03-07 mpb
+