From f3373d08c74e36b2161e1f4e4eef6aa7197352e0 Mon Sep 17 00:00:00 2001 From: Indrajith K L Date: Fri, 7 Nov 2025 04:44:30 +0530 Subject: docs: Add HTML documentation generator and improve documentation structure - Add html_docs/ directory with Python-based documentation generator - Include custom CSS styling for modern, clean documentation layout - Update README.md with improved formatting and documentation links - Enhance markdown documentation across all docs/ files: - Improve API documentation with better code examples - Refactor DOCUMENTATION_INDEX.md for clearer navigation - Update EMBEDDING.md, CUSTOMIZATION.md, and other guides - Standardize formatting and improve readability throughout - Fix inconsistent line endings and formatting issues The HTML documentation generator creates a styled, browsable version of the project documentation for easier reading and navigation. --- docs/BUILD_SCRIPTS.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'docs/BUILD_SCRIPTS.md') diff --git a/docs/BUILD_SCRIPTS.md b/docs/BUILD_SCRIPTS.md index 875ef0b..191bd37 100644 --- a/docs/BUILD_SCRIPTS.md +++ b/docs/BUILD_SCRIPTS.md @@ -19,24 +19,24 @@ Fast iteration during game development with external Lua files and assets. ### Usage -**Windows:** +Windows: ```cmd scripts\build_dev.bat ``` -**Linux/Unix:** +Linux/Unix: ```bash chmod +x scripts/build_dev.sh scripts/build_dev.sh ``` ### Features -- ✅ No embedding - loads Lua and assets from file system -- ✅ Fast build times -- ✅ Edit code and assets without rebuilding -- ✅ Automatic cleanup of embedded files -- ✅ Warns if Lua files or assets are in build directory -- ✅ Optional clean build: `scripts\build_dev.bat clean` or `scripts/build_dev.sh clean` +- No embedding - loads Lua and assets from file system +- Fast build times +- Edit code and assets without rebuilding +- Automatic cleanup of embedded files +- Warns if Lua files or assets are in build directory +- Optional clean build: `scripts\build_dev.bat clean` or `scripts/build_dev.sh clean` ### Output - Development executable: `build/ReiLua.exe` @@ -67,25 +67,25 @@ copy ..\your_game\assets\* assets\ ### Usage -**Windows:** +Windows: ```cmd scripts\build_release.bat ``` -**Linux/Unix:** +Linux/Unix: ```bash chmod +x scripts/build_release.sh scripts/build_release.sh ``` ### Features -- ✅ Embeds all Lua files from `build/` directory -- ✅ Embeds all assets from `build/assets/` folder -- ✅ Creates single-file executable -- ✅ Release optimization enabled -- ✅ Verifies Lua files and assets before building -- ✅ Shows summary of embedded files after build -- ✅ Interactive confirmation before building +- Embeds all Lua files from `build/` directory +- Embeds all assets from `build/assets/` folder +- Creates single-file executable +- Release optimization enabled +- Verifies Lua files and assets before building +- Shows summary of embedded files after build +- Interactive confirmation before building ### Output - Release executable: `build/ReiLua.exe` -- cgit v1.2.3