From 2265be243ccbf57f36451f5f32857bd63202dd80 Mon Sep 17 00:00:00 2001
From: EvilFactory <evilfactory@users.noreply.github.com>
Date: Thu, 26 Sep 2024 19:04:45 -0300
Subject: [PATCH] Create README.md

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e695754
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Luatrauma.Docs
+
+This is the documentation source hosted at https://luatrauma.github.io/Luatrauma.Docs/
+
+## How to build
+
+This documentation has three components:
+
+The manual, which uses mkdocs.
+The CSharp API documentation, which uses doxygen.
+The Lua API documentation, which uses ldoc.
+
+Note all of the build scripts are written for Linux (windows is a fucking pain), so if you are on Windows, you can use WSL to run the scripts.
+
+### Manual
+
+To build the manual, you need to have material for mkdocs installed. You can install it with pip:
+
+```bash
+pip install mkdocs-material
+```
+
+Now you can just run `./serve_manual.sh` to build and serve the manual.
+
+### CSharp API
+
+Run `install_doxygen.sh` first and then run `build_api_cs.sh`, the documentation files will be generated at `build/api/cs/client` and `build/api/cs/server`.
+
+### Lua API
+
+First make sure you have Lua 5.2, Lua headers and Luarocks installed in your system.
+
+Run `build_api_lua.sh`, the documentation files will be generated at `build/api/lua/`.
\ No newline at end of file