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.
This commit is contained in:
@@ -91,7 +91,7 @@ Successfully ported embedded assets, splash screens, and asset loading features
|
||||
|
||||
### Quick Build (Recommended)
|
||||
|
||||
**Development (Fast Iteration):**
|
||||
Development (Fast Iteration):
|
||||
```bash
|
||||
# Windows
|
||||
scripts\build_dev.bat
|
||||
@@ -100,7 +100,7 @@ scripts\build_dev.bat
|
||||
scripts/build_dev.sh
|
||||
```
|
||||
|
||||
**Release (Single Executable):**
|
||||
Release (Single Executable):
|
||||
```bash
|
||||
# Copy files to build directory first
|
||||
cd build
|
||||
@@ -120,7 +120,7 @@ scripts/build_release.sh
|
||||
|
||||
### Manual Build
|
||||
|
||||
**Development Build (Fast Iteration):**
|
||||
Development Build (Fast Iteration):
|
||||
```bash
|
||||
cmake -G "MinGW Makefiles" ..
|
||||
mingw32-make
|
||||
@@ -129,7 +129,7 @@ mingw32-make
|
||||
- Fast edit-and-run workflow
|
||||
- Use `--no-logo` to skip splash screens
|
||||
|
||||
**Release Build (Single Executable):**
|
||||
Release Build (Single Executable):
|
||||
```bash
|
||||
# Copy Lua files and assets to build directory
|
||||
copy ..\*.lua .
|
||||
@@ -157,14 +157,14 @@ Options:
|
||||
```
|
||||
|
||||
## Testing
|
||||
✅ Build compiles successfully
|
||||
✅ Logos and font embedded automatically
|
||||
✅ Asset loading API functions registered
|
||||
✅ Splash screens implemented and working
|
||||
✅ Console control working (Windows)
|
||||
✅ Documentation complete
|
||||
✅ SEGV crash fixed - window initializes before splash screens
|
||||
✅ Runs successfully with and without --no-logo flag
|
||||
Build compiles successfully
|
||||
Logos and font embedded automatically
|
||||
Asset loading API functions registered
|
||||
Splash screens implemented and working
|
||||
Console control working (Windows)
|
||||
Documentation complete
|
||||
SEGV crash fixed - window initializes before splash screens
|
||||
Runs successfully with and without --no-logo flag
|
||||
|
||||
## Known Changes from Original ReiLua
|
||||
- `RL.config()` callback removed - window now initializes automatically
|
||||
|
||||
Reference in New Issue
Block a user