From efccd1b4047066afedebe42a727db20fc3b2d905 Mon Sep 17 00:00:00 2001 From: Medik Date: Wed, 25 Sep 2024 12:32:00 +0100 Subject: [PATCH] Add details on how to contribute to documentation --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index a90965de..f0fcd6bd 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,7 @@ For a full list of EOP Events, see [here](https://youneuoy.github.io/M2TWEOP-lib ## Building Locally +### M2TWEOP Library and GUI **Requirements** * [Microsoft Visual Studio 2022](https://community.chocolatey.org/packages/visualstudio2022community) @@ -124,6 +125,14 @@ Use [Choco](https://chocolatey.org/install) for easy installation of the DirectX You can get support for building/developing on our [Discord](https://discord.gg/Epqjm8u2WK) server. +### Documentation +If you want to open a PR to fix documentation/Intellisense issue, please refer to the following files + +* `LuaDocs.lua` is generated from the files defined in [config.ld](https://github.com/youneuoy/M2TWEOP-library/blob/master/documentationGenerator/config.ld#L3) +* `ImGUILuaDocs.lua` is generated from [sol_ImGui.cpp](https://github.com/youneuoy/M2TWEOP-library/blob/master/M2TWEOP%20Code/M2TWEOP%20library/imgui/sol_ImGui.cpp) + +See the [README](https://github.com/youneuoy/M2TWEOP-library/tree/master/documentationGenerator) in the documentationGenerator folder for more details + ## Disclaimer * Do not include the project in a mod without prior permission (this is simply to keep track of usage)