From b6709997ccc3ff66cc73e01503edda128e130143 Mon Sep 17 00:00:00 2001
From: Daniel Thompson <daniel@redfelineninja.org.uk>
Date: Sun, 20 Jun 2021 10:43:25 +0100
Subject: apps: DemoApp: Fully document the demo app

The demo app is of somewhat niche interest and is disabled by default
but arguable that makes it more important to document it fully since
this app is harder to find the many others.

Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>

diff --git a/README.rst b/README.rst
index b96f77a..81b4439 100644
--- a/README.rst
+++ b/README.rst
@@ -145,6 +145,10 @@ simulator:
    :alt: Digital clock application running on the wasp-os simulator
    :width: 179
 
+.. image:: res/DemoApp.png
+   :alt: Simple always-on demo for showing off wasp-os at conferences and shows
+   :width: 179
+
 .. image:: res/HeartApp.png
    :alt: Heart rate application running on the wasp-os simulator
    :width: 179
diff --git a/docs/apps.rst b/docs/apps.rst
index 39205ae..17bf149 100644
--- a/docs/apps.rst
+++ b/docs/apps.rst
@@ -45,6 +45,8 @@ Applications
 
 .. automodule:: apps.calc
 
+.. automodule:: apps.demo
+
 .. automodule:: apps.flashlight
 
 .. automodule:: apps.haiku
diff --git a/res/DemoApp.png b/res/DemoApp.png
new file mode 100644
index 0000000..6d5e21a
Binary files /dev/null and b/res/DemoApp.png differ
diff --git a/wasp/apps/demo.py b/wasp/apps/demo.py
index 17b31c6..b49655c 100644
--- a/wasp/apps/demo.py
+++ b/wasp/apps/demo.py
@@ -8,6 +8,19 @@ This demo is simply an alternating sweep of the Pine64 and
 MicroPython logos. It cycles through a variety of colours
 and swaps between the logos every 5 images (so if you change
 anything make sure len(colors) is not a multiple of 5).
+
+.. figure:: res/DemoApp.png
+    :width: 179
+
+The demo also includes code to keep the devie awake making it
+suitable to run as an always-on application to demonstrate wasp-os at
+conferences and shows.
+
+.. note::
+
+    Due to it's niche purpose and relatively large size this app is not
+    included by default in the flash images. It must be separately installed
+    and enabled.
 """
 
 import wasp
diff --git a/wasp/boards/simulator/test_qa.py b/wasp/boards/simulator/test_qa.py
index 7f38995..04dab15 100644
--- a/wasp/boards/simulator/test_qa.py
+++ b/wasp/boards/simulator/test_qa.py
@@ -3,7 +3,7 @@ import wasp
 import importlib
 import os
 
-EXCLUDE = ('Notifications', 'Template', 'Demo', 'Faces')
+EXCLUDE = ('Notifications', 'Template', 'Faces')
 
 def test_README(constructor):
     if constructor.NAME in EXCLUDE:
-- 
cgit v0.10.2