diff --git a/README.md b/README.md index d6e8d5162..9e5e7e7c4 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,6 @@ Further documentation - Forum: https://forum.luanti.org/ - GitHub: https://github.com/luanti-org/luanti/ - [Developer documentation](doc/developing/) -- [Documentation index](doc/README.md) - [doc/](doc/) directory of source distribution Default controls diff --git a/doc/README.md b/doc/README.md index 408d4959f..2b599f97e 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,37 +1,42 @@ # Documentation Index -The following is a list of documentation files and a brief description, if - applicable, to aid in locating documentation (sorted alphabetically - per-section). +The following is a list of documentation files and a brief description to aid + in locating documentation (sorted alphabetically per-section). ## Lua -- [Builtin Entities](builtin_entities.md): Doc for predefined engine entities, i.e. dropped items and falling nodes. -- [Client-side API](client_lua_api.md): Client side enviorment's Lua API. -- [Formspec Toolkit API](fst_api.txt) -- [Menu API](menu_lua_api.md): Lua API for the creation of engine menus, not the - mod API. -- [Mod APIs](lua_api.md): Lua APIs avalible within the mod enviorment and mapgen - enviorment. Contains infromation related to texturing and structure of games, - mods, and texture packs. **Related**: [Texture Packs](texture_packs.md) and - [World Format](world_format.md). +- [builtin_entities.md](builtin_entities.md): Doc for predefined engine + entities, i.e. dropped items and falling nodes. +- [client_lua_api.md](client_lua_api.md): Client side enviorment's Lua API. +- [fst_api.txt](fst_api.txt): Formspec Toolkit API, this is for the engine's + menus (Manu menu, world creation dialogs, etc.) +- [menu_lua_api.md](menu_lua_api.md): Lua API for the creation of engine menus, + not the mod API. +- [lua_api.md](lua_api.md): Lua APIs for server mods. Documents the normal mod + enviorment and mapgen enviorment and contains infromation related to + texturing and structure of games, mods, and texture packs. ## Formats and Content -- [Texture Packs](texture_packs.md): Layout and description of Luanti's texture - packs structure and configuration. Related information can be found in the - [mod API](lua_api.md). -- [World Format](world_format.md): Layout and description of Luanti's world +- [texture_packs.md](texture_packs.md): Layout and description of Luanti's + texture packs structure and configuration. Related information can be + found in the [mod API](lua_api.md). +- [world_format.md](world_format.md): Layout and description of Luanti's world format. Documents the structure of the dirrectories and the files therein, including the structure of the internal world related databases. - -## Protocals - -- [Protocol](protocol.txt): *Rough* outline of Luanti's network protocol. + **Important**: Due to incompleatness of this documentation, it is + recommended to read the serialize and deserialize functions in C++ to + better understand this documentation. +- [protocol.txt](protocol.txt): *Rough* outline of Luanti's network protocol. ## Misc. -- [Android Information](android.md) -- [Docker Server](docker_server.md) -- [Luanti Development Direction](direction.md) -- [List of Major Breakages](breakages.md) \ No newline at end of file +- [android.md](android.md) Android related information. +- [breakages.md](breakages.md) List of major breakages. +- [compiling/](compiling/) Compilation information and instructions. +- [developing/](developing/) Extra information about Luanti development, e.g. + OS-related information. +- [direction.md](direction.md) Information related to the future direction of + Luanti. +- [docker_server.md](docker_server.md) Infromation about Docker server images. +- [ides/](ides/) Information about IDE configuration. \ No newline at end of file