diff --git a/README.md b/README.md index 3c962fe..78e7212 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ EspruinoAppLoaderCore [![Build Status](https://github.com/espruino/EspruinoAppLoaderCore/actions/workflows/nodejs.yml/badge.svg)](https://github.com/espruino/EspruinoAppLoaderCore/actions/workflows/nodejs.yml) -This is the code use for both: +This is the code used for both: * [Bangle.js](https://banglejs.com/) App Loader : https://github.com/espruino/BangleApps * [Espruino](http://www.espruino.com/) App Loader : https://github.com/espruino/EspruinoApps @@ -13,3 +13,10 @@ onto embedded devices. See https://github.com/espruino/BangleApps for more details on usage and the format of `apps.json`. + +## Testing +To test different changes: +1. Clone the `BangleApps` repository on your local machine. +2. Make changes to this submodule inside the BangleApps folder `core`. In GitHub web, it's shown as a link to the submodule, but in a clone on your PC, it has all the files that this module has. +3. Test using `index.html`, and when you are ready, migrate changes to here +4. Create a PR to merge your changes with the upstream repository