From 46fb48a74153cd3e56b6ea11ca9450ce8756cebc Mon Sep 17 00:00:00 2001 From: Alexander Kiranov Date: Fri, 22 Dec 2023 14:58:27 +0200 Subject: [PATCH] markdown improve --- README.md | 2 ++ docs_topics/03-lua_versions.md | 2 ++ docs_topics/README.md | 11 +++++++++++ 3 files changed, 15 insertions(+) create mode 100644 docs_topics/README.md diff --git a/README.md b/README.md index 27d9f14..91d563f 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,8 @@ From LuaRocks: See [https://xhaskx.github.io/luamqtt/](https://xhaskx.github.io/luamqtt/) +[More details](./docs_topics/README.md) + # Forum See [flespi forum thread](https://forum.flespi.com/d/97-luamqtt-mqtt-client-written-in-pure-lua) diff --git a/docs_topics/03-lua_versions.md b/docs_topics/03-lua_versions.md index 52c376c..b71ad81 100644 --- a/docs_topics/03-lua_versions.md +++ b/docs_topics/03-lua_versions.md @@ -6,4 +6,6 @@ It's tested to work on Debian 9 GNU/Linux with Lua versions: * LuaJIT 2.0.0 ... LuaJIT 2.1.0 beta3 * It may also work on other Lua versions without any guarantees +So basically it should work on any modern Linux-based OS with Lua interpreter available. + Also has run under **Windows** and it was ok, but installing luarocks-modules may be a non-trivial task on this OS. diff --git a/docs_topics/README.md b/docs_topics/README.md new file mode 100644 index 0000000..221fa39 --- /dev/null +++ b/docs_topics/README.md @@ -0,0 +1,11 @@ +# Short documentation topics + +[Installation](./01-installation.md) + +[Dependencies](./02-dependencies.md) + +[Lua versions](./03-lua_versions.md) + +[MQTT versions](./04-mqtt_versions.md) + +[Connectors](./05-connectors.md)