diff --git a/README.md b/README.md index 0e1d8ac..11f5aa5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # mt-lua-api-pyparse -Minetest Lua API Python Parser by Lars Müller alias LMD or appgurueu. -Uses Bootstrap 4 and JQuery to generate a beautiful HTML Website, table of content inclusive ! +Minetest Lua API Python Parser +Written by Lars Müller alias LMD or appgurueu, mainly for educational purposes; I needed to train my rusty python again :P +Only works with reduced Markdown set, as required for lua_api.txt. +Uses Bootstrap 4 and JQuery to generate a beautiful HTML Website from lua_api.txt, table of content inclusive ! Just for fun, a background Minetest Scene is generated each time, too ! +I think this may be useful, as currently, the only way to navigate through lua_api.txt is a full-text search in the browser. Licence : GPLv3 + +"The images" are in the following all images except "background.png", which is generated. +Please note that I did **not** create the the images included here. They are part of Minetest Game and licensed under CC-BY-SA 3.0, as far as I know.