Documented demo.

jfjlaros · Dec 8, 2018 · 7f3afdf · 7f3afdf
1 parent bccfe4a
commit 7f3afdf
Show file tree

Hide file tree

Showing 11 changed files with 24 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,2 @@
-device/.build/
-device/lib/.holder
+example/device/.build/
+example/device/lib/.holder
diff --git a/.gitmodules b/.gitmodules
@@ -1,6 +1,6 @@
 [submodule "device/lib/simpleRPC"]
-	path = device/lib/simpleRPC
+	path = example/device/lib/simpleRPC
 	url = https://github.com/jfjlaros/simpleRPC.git
 [submodule "device/lib/arduino-peripherals"]
-	path = device/lib/arduino-peripherals
+	path = example/device/lib/arduino-peripherals
 	url = https://github.com/jfjlaros/arduino-peripherals.git
diff --git a/device/lib/display b/device/lib/display
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -69,5 +69,24 @@ integers.
     display.delay(20);        // Dim the display.
     display.displayInt(-123); // Show the string "-123".
 
+Demo
+^^^^
+
+A demo_ is provided to show the full functionality of the display and other
+peripherals. This demo is written in Python 3.
+
+First make sure all dependencies are installed.
+
+::
+
+    pip install -r requirements.txt
+
+Run the demo as follows.
+
+::
+
+    python demo.py
+
 
 .. _arduino-peripherals: https://arduino-peripherals.readthedocs.io
+.. _demo: https://github.com/jfjlaros/vma209/tree/master/example/host
diff --git a/device/ino.ini → example/device/ino.ini b/device/ino.ini → example/device/ino.ini
diff --git a/device/lib/arduino-peripherals → example/device/lib/arduino-peripherals b/device/lib/arduino-peripherals → example/device/lib/arduino-peripherals
diff --git a/example/device/lib/display b/example/device/lib/display
@@ -0,0 +1 @@
+../../../display/
diff --git a/device/lib/simpleRPC → example/device/lib/simpleRPC b/device/lib/simpleRPC → example/device/lib/simpleRPC
diff --git a/device/src/device.ino → example/device/src/device.ino b/device/src/device.ino → example/device/src/device.ino
diff --git a/host/demo.py → example/host/demo.py b/host/demo.py → example/host/demo.py
diff --git a/host/requirements.txt → example/host/requirements.txt b/host/requirements.txt → example/host/requirements.txt