FOSS
/
BangleApps
mirror of https://github.com/espruino/BangleApps
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

update docs to put the best solution at the top

pull/2363/head
Gordon Williams 2022-12-06 09:41:54 +00:00
parent 26522b3bd8
commit 341517881b
1 changed files with 27 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
modules/README.md
View File

@ -18,28 +18,6 @@ so you may see the error "Module <module_name> not found" in the IDE when sendin
To fix this you have three options: To fix this you have three options:
### Host your own App Loader and upload from that
This is reasonably easy to set up, but it's more difficult to make changes and upload:
* Follow the steps here to set up your own App Loader: https://www.espruino.com/Bangle.js+App+Loader
* Make changes to that repository
* Refresh and upload your app from the app loader (you can have the IDE connected
at the same time so you can see any error messages)
### Upload the module to the Bangle's internal storage
This allows you to develop both the app and module very quickly, but the app is
uploaded in a slightly different way to what you'd get when you use the App Loader
or the method below:
* Load the module's source file in the Web IDE
* Click the down-arrow below the upload button, then `Storage`
* Click `New File`, type `your_module_name` as the name (with no `.js` extension), click `Ok`
* Now Click the `Upload` icon.
You can now upload the app direct from the IDE. You can even leave a second Web IDE window open
(one for the app, one for the module) to allow you to change the module.
### Change the Web IDE search path to include Bangle.js modules ### Change the Web IDE search path to include Bangle.js modules
@ -56,3 +34,30 @@ The next time you upload your app, the module will automatically be included.
**Note:** You can optionally use `https://raw.githubusercontent.com/espruino/BangleApps/master/modules|https://www.espruino.com/modules` **Note:** You can optionally use `https://raw.githubusercontent.com/espruino/BangleApps/master/modules|https://www.espruino.com/modules`
as the module URL to pull in modules direct from the development app loader (which could be slightly newer than the ones on https://banglejs.com/apps) as the module URL to pull in modules direct from the development app loader (which could be slightly newer than the ones on https://banglejs.com/apps)
### Host your own App Loader and upload from that
This is reasonably easy to set up, but it's more difficult to make changes and upload:
* Follow the steps here to set up your own App Loader: https://www.espruino.com/Bangle.js+App+Loader
* Make changes to that repository
* Refresh and upload your app from the app loader (you can have the IDE connected
at the same time so you can see any error messages)
### Upload the module to the Bangle's internal storage
This allows you to develop both the app and module very quickly, but the app is
uploaded in a slightly different way to what you'd get when you use the App Loader
or the method below:
* Load the module's source file in the Web IDE
* Click the down-arrow below the upload button, then `Storage`
* Click `New File`, type `your_module_name` as the name (with no `.js` extension), click `Ok`
* Now Click the `Upload` icon.
You can now upload the app direct from the IDE. You can even leave a second Web IDE window open
(one for the app, one for the module) to allow you to change the module.