summaryrefslogtreecommitdiff
path: root/doc/code
diff options
context:
space:
mode:
authorEli Weiss <eliwss0@gmail.com>2021-12-05 10:41:01 -0600
committerJF <JF002@users.noreply.github.com>2021-12-30 20:57:26 +0100
commit97668c775bb5e501b32fce2fc92f4a5995aec1b1 (patch)
treec6547322c9387b83e7058b82b30c22fae0447b74 /doc/code
parent90352af626cc0087143e824f62f5dcee9f58f29c (diff)
Improved "Getting Started" readability
Clarified ambiguous references, clarified phrasing
Diffstat (limited to 'doc/code')
-rw-r--r--doc/code/Apps.md6
-rw-r--r--doc/code/Intro.md4
2 files changed, 5 insertions, 5 deletions
diff --git a/doc/code/Apps.md b/doc/code/Apps.md
index b1c7d20e..0e6d13cf 100644
--- a/doc/code/Apps.md
+++ b/doc/code/Apps.md
@@ -8,8 +8,8 @@ This page will teach you:
The user interface of InfiniTime is made up of **screens**.
Screens that are opened from the app launcher are considered **apps**.
Every app in InfiniTime is it's own class.
-An instance of the class is created when the app is launched and destroyed when the user exits the app.
-They run inside the "displayapp" task (briefly discussed [here](./Intro.md)).
+An instance of the class is created when the app is launched, and destroyed when the user exits the app.
+Apps run inside the "displayapp" task (briefly discussed [here](./Intro.md)).
Apps are responsible for everything drawn on the screen when they are running.
By default, apps only do something (as in a function is executed) when they are created or when a touch event is detected.
@@ -21,7 +21,7 @@ A destructor is needed to clean up LVGL and restore any changes (for example re-
App classes can override `bool OnButtonPushed()`, `bool OnTouchEvent(TouchEvents event)` and `bool OnTouchEvent(uint16_t x, uint16_t y)` to implement their own functionality for those events.
If an app only needs to display some text and do something upon a touch screen button press,
it does not need to override any of these functions, as LVGL can also handle touch events for you.
-If you have any doubts, you can always look at how the other apps are doing things.
+If you have any doubts, you can always look at how the other apps function for examples.
### Continuous updating
If your app needs to be updated continuously, you can do so by overriding the `Refresh()` function in your class
diff --git a/doc/code/Intro.md b/doc/code/Intro.md
index bf68c7a5..23b3ade1 100644
--- a/doc/code/Intro.md
+++ b/doc/code/Intro.md
@@ -24,9 +24,9 @@ There are also other tasks that are responsible for Bluetooth ("ll" and "ble" in
and periodic tasks like heartrate measurements ([heartratetask/HeartRateTask.cpp](/src/heartratetask/HeartRateTask.cpp)).
While it is possible for you to create your own task when you need it, it is recommended to just add functionality to `SystemTask::Work()` if possible.
-If you absolutely need to create another task, try to guess how much [stack space](https://www.freertos.org/FAQMem.html#StackSize) (in words/4-byte packets)
+If you absolutely need to create another task, try to estimate how much [stack space](https://www.freertos.org/FAQMem.html#StackSize) (in words/4-byte packets)
it will need instead of just typing in a large-ish number.
-You can use the define `configMINIMAL_STACK_SIZE` which is currently set to 120 words.
+You can use `configMINIMAL_STACK_SIZE` which is currently set to 120 words.
## Controllers
Controllers in InfiniTime are singleton objects that can provide access to certain resources to apps.