pinetime/wasp-os
1
0
Fork 0
Code Activity
wasp-os/docs/apps.rst

60 lines
781 B
ReStructuredText
Raw Normal View History

docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
.. _Application Library:
Application Library
===================
.. contents::
:local:
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
Watch faces
-----------
.. automodule:: apps.clock
.. automodule:: apps.chrono
.. automodule:: apps.fibonacci_clock
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
Built-in
--------
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.heart
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.stopwatch
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.steps
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.launcher
apps: chrono: Implement a simple analogue watch face Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-12-27 10:13:49 +01:00
docs: Move all applications out of the reference guide The auto-generated application docs isn't really worthy of the reference guide. There's too many methods described as "draws the screen" and this simply doesn't add anything over the template application includes in the application writer's guide. Move everything over into the Application Library. Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-13 23:06:26 +01:00
.. automodule:: apps.settings
.. automodule:: apps.software
.. automodule:: apps.pager
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
Applications
------------
docs: Add an Application Library chapter Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-08 15:28:38 +01:00
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.alarm
apps: play2048: Add the 2048 game application 2048 is a popular sliding block puzzle game in which tiles are combined to make the number 2048. It's one of the few games that are enjoyable to play on such a small form factor. This started as a port of a TkInter implementation of the 2048 game. I implemented all of the TkInter APIs used by the game and it worked on wasp-os without any code change in the game. However, the performance was very poor and it consumed too much RAM. I have since reimplemented the whole game from scratch and managed to achieve acceptable performance, although more improvements could still be made. Because names in Python can't start with numbers, I had some trouble naming things. The module is called "ttfe" (two-thousand-forty-eight), the class name is Play2048App, and the software.py entry is "Play 2048". Signed-off-by: Miguel Rochefort <miguelrochefort@gmail.com> [daniel@redfelineninja.org.uk: Renamed the python filename, normalized the screenshot and included the app in the docs] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-05 04:12:39 +01:00
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.calc
apps: snake: Add a snake game application Signed-off-by: Johannes Wache <jbwa@posteo.de> [daniel@redfelineninja.org.uk: Removed some couple of unwanted merge artifacts] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-11-27 11:39:40 +01:00
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.flashlight
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>
2020-11-22 10:22:50 +01:00
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.haiku
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>
2020-11-29 13:23:05 +01:00
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>
2020-11-22 10:22:50 +01:00
.. automodule:: apps.musicplayer
apps: timer: Add a countdown timer application Signed-off-by: Wolfgang Ginolas <wolfgang.ginolas@gwif.eu> [daniel@redfelineninja.org.uk: squashed into a single commit, rebase to latest master, integrate with the Software application and rename the screenshots to match the application name] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-12-31 17:18:13 +01:00
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
.. automodule:: apps.testapp
apps: timer: Add a countdown timer application Signed-off-by: Wolfgang Ginolas <wolfgang.ginolas@gwif.eu> [daniel@redfelineninja.org.uk: squashed into a single commit, rebase to latest master, integrate with the Software application and rename the screenshots to match the application name] Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2020-12-31 17:18:13 +01:00
.. automodule:: apps.timer
simulator: test_qa: Check that apps are includes in the library Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
2021-01-12 23:33:25 +01:00
Games
-----
.. automodule:: apps.gameoflife
.. automodule:: apps.play2048
.. automodule:: apps.snake
Copy permalink