indrajith/reilua-enhanced
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add HTML documentation generator and improve documentation structure

Browse Source 
- 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:
Indrajith K L
2025-11-07 04:44:30 +05:30
parent 8c4b587a23
commit f3373d08c7
16 changed files with 8831 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/CUSTOMIZATION.md
View File

@@ -322,11 +322,11 @@ YourGame.exe
```
Verify:
- ✅ Executable has correct name
- ✅ Icon appears in file explorer
- ✅ Right-click → Properties shows correct info
- ✅ Splash screens display correctly
- ✅ Loading screen appears as expected
- Executable has correct name
- Icon appears in file explorer
- Right-click → Properties shows correct info
- Splash screens display correctly
- Loading screen appears as expected
## Checklist: Release-Ready Customization
@@ -359,22 +359,22 @@ Before releasing your game:
## Troubleshooting
**Icon doesn't change:**
Icon doesn't change:
- Ensure .ico file is valid
- Rebuild completely (clean build)
- Clear icon cache (Windows): Delete `IconCache.db`
**Properties don't update:**
Properties don't update:
- Verify `resources.rc` syntax is correct
- Rebuild completely
- Check that resource compiler ran (check build output)
**Splash screens don't show changes:**
Splash screens don't show changes:
- Rebuild with clean build
- Check `scripts/embed_logo.py` ran successfully
- Verify logo files exist in `logo/` folder
**Executable name unchanged:**
Executable name unchanged:
- Check `CMakeLists.txt` project name
- Do a clean rebuild
- Verify cmake configuration step succeeded