summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Thompson <daniel@redfelineninja.org.uk>2020-11-22 09:22:50 (GMT)
committerDaniel Thompson <daniel@redfelineninja.org.uk>2020-11-22 09:22:50 (GMT)
commit6f0238415ff55e9e5969465c811a86781963ff87 (patch)
tree3edd568f180ef1306d07a5e6c95eef8b85a1486b /docs
parentfd0e0d77aa9ca90f0cb110a31fb098d189b87114 (diff)
apps: music: Add to application index
Additionally we rename the screenshot to conform to the naming convention (app.NAME + 'App.png') used for simulator screenshots. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
Diffstat (limited to 'docs')
-rw-r--r--docs/apps.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/apps.rst b/docs/apps.rst
index 7b24401..9decb62 100644
--- a/docs/apps.rst
+++ b/docs/apps.rst
@@ -37,3 +37,13 @@ Games
This is enabled by default in the simulator. The app is bundled in the
firmware image but it is disabled by default to keep RAM available for
user developed applications. It can be enabled by modifying ``main.py``.
+
+Integration
+-----------
+
+.. automodule:: apps.musicplayer
+
+This app is enabled by default in the simulator.
+The app is also frozen into the firmware image but it is disabled by
+default in order to keep RAM available for user developed applications.
+It can be enabled by modifying ``main.py``.