Skip to content

Commit

Permalink
update docs to put the best solution at the top
Browse files Browse the repository at this point in the history
  • Loading branch information
gfwilliams committed Dec 6, 2022
1 parent 26522b3 commit 3415178
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,24 @@ so you may see the error "Module <module_name> not found" in the IDE when sendin

To fix this you have three options:


### Change the Web IDE search path to include Bangle.js modules

This is nice and easy (and the results are the same as if the app was
uploaded via the app loader), however you cannot then make/test changes
to the module.

* In the IDE, Click the `Settings` icon in the top right
* Click `Communications` and scroll down to `Module URL`
* Now change the module URL from the default of `https://www.espruino.com/modules`
to `https://banglejs.com/apps/modules|https://www.espruino.com/modules`

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`
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:
Expand All @@ -27,6 +45,7 @@ This is reasonably easy to set up, but it's more difficult to make changes and u
* 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
Expand All @@ -41,18 +60,4 @@ or the method below:
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

This is nice and easy (and the results are the same as if the app was
uploaded via the app loader), however you cannot then make/test changes
to the module.

* In the IDE, Click the `Settings` icon in the top right
* Click `Communications` and scroll down to `Module URL`
* Now change the module URL from the default of `https://www.espruino.com/modules`
to `https://banglejs.com/apps/modules|https://www.espruino.com/modules`

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`
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)

0 comments on commit 3415178

Please sign in to comment.