Update README.md

README.md

@@ -0,0 +1,306 @@
+# Customer Unity Template
+
+## Overview
+
+The Customer Unity Template is the standard onboarding repository used by Runlevel Systems DevPlus1 when working with customer Unity projects.
+
+This repository provides:
+
+- Automated Forgejo validation workflows
+- Source code documentation generation
+- API reference generation
+- Static call map generation
+- Project structure reporting
+- Unity Editor project analysis tools
+- AI-ready project context generation
+- Standardized documentation for developers and AI assistants
+
+The goal is to quickly understand a customer project without manually reviewing every file and to provide a consistent workflow across all Unity customer engagements.
+
+-------------------------------------------------------------------------------
+
+# Repository Structure
+
+customer-unity-template/
+│
+├── .forgejo/
+│   └── workflows/
+│
+├── tools/
+│
+├── docs/
+│
+├── RL_DOCS/
+│
+├── Assets/
+│   └── RL_DevPlus1/
+│       ├── Editor/
+│       ├── Runtime/
+│       ├── Reports/
+│       └── Docs/
+│
+├── README.md
+└── .gitignore
+
+-------------------------------------------------------------------------------
+
+# Workflow Overview
+
+## Phase 1 - Customer Repository Import
+
+Customer source code is imported into a repository created from this template.
+
+Examples:
+
+- Unity projects
+- Unity game prototypes
+- Mobile game projects
+- Business simulation projects
+- Training simulator projects
+
+-------------------------------------------------------------------------------
+
+## Phase 2 - Forgejo Validation
+
+When code is pushed:
+
+Developer Push
+      ↓
+Forgejo Actions
+      ↓
+Validation Scripts
+      ↓
+Documentation Generation
+      ↓
+Reports Created
+
+Validation performs:
+
+- PHP syntax checking
+- C# compilation validation when possible
+- JavaScript validation
+- Python validation
+- Shell script validation
+- YAML validation
+- Additional language support as implemented
+
+Generated reports are stored in:
+
+reports/
+
+-------------------------------------------------------------------------------
+
+## Phase 3 - Documentation Generation
+
+The repository automatically generates:
+
+### API Reference
+
+reports/api-reference.md
+
+Contains:
+
+- Classes
+- Functions
+- Methods
+- Parameters
+- Return types
+- File locations
+
+### File Purpose Report
+
+reports/file-purpose.md
+
+Contains:
+
+- File descriptions
+- Likely responsibilities
+- Dependencies
+- High-level purpose
+
+### Call Map
+
+reports/call-map.md
+
+Contains:
+
+- Possible execution flow
+- Function relationships
+- Entry points
+- Dependencies
+
+### Validation Results
+
+reports/errors.md
+
+Contains:
+
+- Validation failures
+- Syntax errors
+- Build issues
+- Warnings
+
+-------------------------------------------------------------------------------
+
+# Unity Analyzer
+
+The Unity-specific analysis tools are located under:
+
+Assets/RL_DevPlus1/
+
+These tools are automatically available within the Unity Editor.
+
+Menu:
+
+Runlevel Systems
+└── DevPlus1
+    ├── Analyze Unity Project
+    ├── Refresh Git Reports
+    └── Open Report Folder
+
+-------------------------------------------------------------------------------
+
+# Unity Analysis Reports
+
+Generated inside:
+
+Assets/RL_DevPlus1/Reports/
+
+Reports include:
+
+RL_Unity_Project_Summary.md
+RL_Unity_Scene_Map.md
+RL_Unity_GameObject_Map.md
+RL_Unity_Script_Map.md
+RL_Unity_Event_Map.md
+RL_Unity_Prefab_Map.md
+RL_Unity_Execution_Order.md
+RL_Unity_Missing_References.md
+RL_AI_Project_Context.md
+
+-------------------------------------------------------------------------------
+
+# AI Integration
+
+The repository is designed so AI assistants can understand a project without reading every source file.
+
+Recommended AI reading order:
+
+1. Assets/RL_DevPlus1/Reports/RL_AI_Project_Context.md
+2. Assets/RL_DevPlus1/Reports/RL_Unity_Project_Summary.md
+3. reports/api-reference.md
+4. reports/call-map.md
+5. Assets/RL_DevPlus1/Reports/RL_Unity_Scene_Map.md
+6. Assets/RL_DevPlus1/Reports/RL_Unity_Script_Map.md
+7. Assets/RL_DevPlus1/Reports/RL_Unity_Event_Map.md
+
+This dramatically reduces analysis time for:
+
+- Codex
+- ChatGPT
+- Claude
+- Future DevPlus1 automation systems
+
+-------------------------------------------------------------------------------
+
+# Developer Workflow
+
+## Initial Setup
+
+Clone repository:
+
+git clone <repository>
+
+Open project in Unity.
+
+Allow Unity to compile.
+
+Run:
+
+Runlevel Systems
+→ DevPlus1
+→ Analyze Unity Project
+
+Generate reports.
+
+Review:
+
+Assets/RL_DevPlus1/Reports/
+
+-------------------------------------------------------------------------------
+
+## Customer Review Process
+
+1. Import customer project.
+2. Allow Forgejo validation to run.
+3. Review generated reports.
+4. Open Unity project.
+5. Run Unity analysis.
+6. Review AI context report.
+7. Begin development.
+
+-------------------------------------------------------------------------------
+
+# Design Principles
+
+This template follows several rules:
+
+- Read-only project analysis.
+- No automatic modification of customer assets.
+- No automatic scene saving.
+- No modification of customer code unless requested.
+- All Runlevel tools remain isolated under:
+
+Assets/RL_DevPlus1/
+
+- Generated reports remain isolated from customer assets.
+- AI-readable reports are always generated.
+
+-------------------------------------------------------------------------------
+
+# RL_DOCS Folder
+
+The RL_DOCS folder contains documentation intended for developers and AI assistants.
+
+Recommended files:
+
+RL_DOCS/
+├── README.md
+├── CODEX_INSTRUCTIONS.md
+├── WORKFLOWS.md
+├── REPORTS.md
+├── TEMPLATE_USAGE.md
+└── CUSTOMER_ONBOARDING.md
+
+Purpose:
+
+- Explain repository structure.
+- Explain workflows.
+- Explain generated reports.
+- Explain customer onboarding.
+- Provide instructions to Codex and future AI assistants.
+
+Whenever possible, AI assistants should read RL_DOCS/CODEX_INSTRUCTIONS.md before analyzing customer code.
+
+-------------------------------------------------------------------------------
+
+# Future Templates
+
+This repository serves as the foundation for:
+
+- customer-unity-template
+- customer-unreal-template
+- customer-dotnet-template
+- customer-web-template
+- customer-python-template
+- customer-generic-template
+
+Each future template will share the same DevPlus1 onboarding and documentation philosophy.
+
+-------------------------------------------------------------------------------
+
+# Runlevel Systems
+
+Design. Debug. Deploy.
+
+The purpose of this template is to allow Runlevel Systems developers to quickly understand, validate, document, and extend customer projects while maintaining a consistent workflow across all engagements.