Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.77 KB

README.md

File metadata and controls

34 lines (24 loc) · 1.77 KB
Raw

Espruino App Loader (and Apps)

Build Status

All software (including apps) in this repository is MIT Licensed - see LICENSE By submitting code to this repository you confirm that you are happy with it being MIT licensed, and that it is not licensed in another way that would make this impossible.

How does it work?

  • Apps are in the apps folder, and each app has metadata.json file describing it (the id must match the folder name)
  • When it starts, EspruinoAppLoader checks the JSON and compares it with the files it sees in storage.
  • To upload an app, EspruinoAppLoader checks the files that are listed in metadata.json, loads them, and sends them over Web Bluetooth.

This is a cut-down version of what's used in https://banglejs.com/apps for Bangle.js apps, so much of the advice in https://github.com/espruino/BangleApps/blob/master/README.md applies.

Differences to banglejs.com/apps

  • We're only handling one app at a time so we don't write the app into a file called appid.app.js, but instead into .bootcde which is the file that the Espruino writes into when writing "To Flash" (for more info see https://www.espruino.com/Saving)
  • We also don't have a launcher, so don't need to provide any 'JS' formatted images for apps

Credits

The majority of icons used for these apps are from Icons8 - we have a commercial license but icons are also free for Open Source projects.