summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Thompson <daniel@redfelineninja.org.uk>2020-11-29 12:23:05 (GMT)
committerDaniel Thompson <daniel@redfelineninja.org.uk>2020-11-29 19:14:31 (GMT)
commit233c136a5c5f1fd4fc940400bc80951c76828811 (patch)
tree50dec3c9f128e36f7c1c4cf6d386bcbb8630d4e8 /docs
parent39c9344b14e22822845254445f35ff598e702fda (diff)
apps: alarm: Add the alarm app to the library
Like the other library applications this is enabled in the simulator and included in the flash image but is disabled by default to conserve RAM (and to give time to new apps to mature and receive improvements). Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
Diffstat (limited to 'docs')
-rw-r--r--docs/apps.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/apps.rst b/docs/apps.rst
index b8fc67c..88ef2d4 100644
--- a/docs/apps.rst
+++ b/docs/apps.rst
@@ -43,6 +43,13 @@ It can be enabled by modifying ``main.py``.
Integration
-----------
+.. automodule:: apps.alarm
+
+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``.
+
.. automodule:: apps.musicplayer
This app is enabled by default in the simulator.