From 4a78580d4e99d0ed60bd9cbcc0b8dc528ac28413 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Sun, 22 Mar 2020 21:43:26 +0100 Subject: [PATCH] Add page about Lua module directory Fixes #3034 --- docs/lua-modules/README.md | 9 +++++++++ mkdocs.yml | 1 + 2 files changed, 10 insertions(+) create mode 100644 docs/lua-modules/README.md diff --git a/docs/lua-modules/README.md b/docs/lua-modules/README.md new file mode 100644 index 00000000..ec0e3fe3 --- /dev/null +++ b/docs/lua-modules/README.md @@ -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) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 360b6514..0a7d78c3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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'