Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add page about Lua module directory
Browse files Browse the repository at this point in the history
Fixes #3034
marcelstoer committed Mar 22, 2020
1 parent f45a9ef commit cb2636d
Showing 2 changed files with 10 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/lua-modules/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# NodeMCU Lua modules directory

Reviewing, hosting and thus potentially maintaining an ever growing list of NodeMCU Lua modules (the ones here) does not scale well for the project team. Instead, we give the community a chance - and the responsibility - to maintain a directory of Lua modules found in the wild through the [GitHub wiki](https://github.com/nodemcu/nodemcu-firmware/wiki/Lua-modules-directory).

In the (hopefully not too distant) future, we will request that Lua modules to be hosted _in this repository_ come with a test program in whatever framework [we end up adopting](https://github.com/nodemcu/nodemcu-firmware/issues/2145).

**A module being listed on the wiki does NOT mean the NodeMCU project team endorses it in any way.**

[https://github.com/nodemcu/nodemcu-firmware/wiki/Lua-modules-directory](https://github.com/nodemcu/nodemcu-firmware/wiki/Lua-modules-directory)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -42,6 +42,7 @@ pages:
- Lua Compact Debug (LCD): 'lcd.md'
- Lua Flash Store (LFS): 'lfs.md'
- Lua Modules:
- 'Lua modules directory': 'lua-modules/README.md'
- 'bh1750': 'lua-modules/bh1750.md'
- 'cohelper': 'lua-modules/cohelper.md'
- 'ds18b20': 'lua-modules/ds18b20.md'

0 comments on commit cb2636d

Please sign in to comment.