aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..923a33e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+## A control UI for ODR-DabMux
+
+Goals of this Web User Interface:
+
+ * Simplify creating basic ODR-DabMux DAB Ensemble configurations
+ * Interact with the ODR-DabMux Remote Control through a web UI
+
+Complilation prerequisites
+
+ * Install Rust, most probably through [rustup](https://rustup.rs/)
+ * Type `cargo run`
+ * Navigate to http://localhost:3000
+ * Create a new Ensemble configuration in the Settings page, and specify where to write the odr-dabmux json config file
+ * Execute `odr-dabmux` with one argument: the configuration file
+ * Check in the Dashboard page that you see RC values