Lua submodule, clone instructions. (#78)

* lua submodule instructions * typos --------- Co-authored-by: François Mentec <[email protected]>
atty303 · Sep 19, 2024 · d87cfc0 · d87cfc0
1 parent 9f108af
commit d87cfc0
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -33,6 +33,18 @@ This is browser version of [Path of Building](https://pathofbuilding.community/)
 - [CMake](https://cmake.org/)
 - [Ninja](https://ninja-build.org/)
 
+### Clone the Repository
+
+This repository includes a [submodule](https://gist.github.com/gitaarik/8735255) in `vendor/lua`. To include the submodule when cloning the repository, use the `--recurse-submodules` flag:
+```bash
+git clone --recurse-submodules <repository-url>
+```
+If you omitted the flag, you can use the following commands to clone the submodule:
+```bash
+git submodule init
+git submodule update
+```
+
 ### Install dependencies
 
 ```bash