Update docs and CI retention (#124)

- Set artifact retention to 30 days
- Update script dscription
- Updated docs
This commit is contained in:
Ken Van Hoeylandt
2024-12-15 09:45:20 +01:00
committed by GitHub
parent f664de898d
commit ca4e29ac0e
9 changed files with 12 additions and 162 deletions
-12
View File
@@ -1,12 +0,0 @@
# Application Lifecycle
The app goes through these states:
![app lifecycle state diagram](pics/app-lifecycle.png)
Let's look at a scenario where an app launches another app:
1. `first` app starts: `first.onStart()` -> `first.onShow()`
2. `second` app starts: `first.onHide()` -> `second.onStart()` -> `second.onShow()`
3. `second` app stops: `second.onHide()` -> `second.onStop()` -> `first.onShow()`
4. `first` app stops: `first.onHide()` -> `first.onStop()`
-18
View File
@@ -1,18 +0,0 @@
# External Apps
## Building
Steps to build:
- Build the main project with `idf.py build` in the root folder of the project
- Open a terminal at `ExternalApps/${AppName}`
- The first time, run `./build.sh` (during consecutive runs, you can run `idf.py build`)
- Find the executable `build/${AppName}.app.elf` and copy it to an SD card.
## Developing apps
Currently, only C is supported. The `TactilityC` project converts Tactility's C++ code into C.
Methods need to be manually exposed to the ELF apps, by editing `TactilityC/Source/TactilityC.cpp`
You can put apps in `Data/config` or `Data/assets` during development, because putting it on an SD card takes more effort.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.3 KiB