Skip to content

Commit e4e71de

Browse files
committed
Updated docs to clarify some points
1 parent 2539d04 commit e4e71de

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/modules/extmods.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ You can now compile the firmware with `make` as usual. The build system will fin
4242

4343
After this is flashed to the device, the module in the example will be available in lua as `helloworld`.
4444

45+
### Updating to the latest code
46+
47+
If your external module entry in `extmods.ini` points to a branch, e.g., `master`, you can update your local version to the latest code anytime by simply running `make extmod-update`.
48+
4549
### Temporarily disabling an external module
4650

4751
If you want to stop compiling and including a module in the build for any reason, without having to remove the entry from `extmods.ini`, simply add a `disabled=true` entry in the module section and run `make extmod-update`.
@@ -75,7 +79,7 @@ Note that the second one points to a different branch, `dev`. Both modules will
7579
To write your own external module do the following:
7680

7781
1. Create an empty repository in your favorite remote, GitHub, BitBucket, GitLab, etc, or fork the helloworld example.
78-
2. Create an entry in `extmods.ini` as explained above. For modules that you author, it is recommended to use an updateable git URL in SSH format, such as `git@github.com:espore-ide/nodemcu-module-helloworld.git`.
82+
2. Create an entry in `extmods.ini` as explained above, with the `url=` key pointing to your repository. For modules that you author, it is recommended to use an updateable git URL in SSH format, such as `git@github.com:espore-ide/nodemcu-module-helloworld.git`.
7983
3. Run `make extmod-update`
8084

8185
You can now change to `components/modules/external/your_module` and begin work. Since that is your own repository, you can work normally, commit, create branches, etc.

0 commit comments

Comments
 (0)