add docs

rox-automation · May 7, 2024 · 0dc0979 · 0dc0979
1 parent e1a5534
commit 0dc0979
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/examples/jupyter_ui.md b/docs/examples/jupyter_ui.md
@@ -0,0 +1 @@
+--8<-- "examples/jupyter_ui/README.md"
diff --git a/examples/jupyter_ui/README.md b/examples/jupyter_ui/README.md
@@ -2,3 +2,9 @@
 
 
 An attempt at using [jupyterlite](https://jupyter.org/try-jupyter/lab/) as an interactive development frontend.
+
+## Quick start
+
+* start `data_generator.py` to produce mock messages
+* start `listener.py` to receive messages
+* TODO: connect to ws from UI client