Add guide for installing lua-doc-extractor

beyond-all-reason · Dec 25, 2024 · 8b1f838 · 8b1f838
1 parent 3c281aa
commit 8b1f838
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/doc/site/README.md b/doc/site/README.md
@@ -17,6 +17,24 @@ Navigate to http://localhost:4000/spring
 
 ## Generating Lua API data
 
+### Updating the Lua definition files
+
+First install `lua-doc-extractor`:
+
+```bash
+npm install -g rhys-vdw/lua-doc-extractor
+```
+
+At root, run:
+
+```bash
+cd rts/Lua/
+rm -rf library/generated
+npx lua-doc-extractor *.cpp --dest library/generated
+```
+
+### Export API data
+
 Have [Lua Language Server](https://luals.github.io/) installed and available at your `$PATH`.
 
 At root, run: