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/CUSTOMIZATION.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'docs/CUSTOMIZATION.md') diff --git a/docs/CUSTOMIZATION.md b/docs/CUSTOMIZATION.md index 388a894..22529be 100644 --- a/docs/CUSTOMIZATION.md +++ b/docs/CUSTOMIZATION.md @@ -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 -- cgit v1.2.3