5dca8ecc79
- Introduced a new "Getting Started" guide to help users set up and use the YAZE software effectively. - Added detailed "Testing Guide" outlining the testing framework and best practices for contributors. - Created "Build Instructions" for macOS, Linux, and Windows, including environment verification and quick start with CMake presets. - Documented the architecture and networking aspects of YAZE, focusing on service-oriented design and gRPC integration. - Updated the index to reflect new documentation structure and improve navigation.
40 lines
1.8 KiB
Markdown
40 lines
1.8 KiB
Markdown
# yaze Documentation
|
|
|
|
Welcome to the official documentation for yaze, a comprehensive ROM editor for The Legend of Zelda: A Link to the Past.
|
|
|
|
## A: Getting Started & Testing
|
|
- [A1: Getting Started](A1-getting-started.md) - Basic setup and usage.
|
|
- [A2: Testing Guide](A1-testing-guide.md) - The testing framework and best practices.
|
|
|
|
## B: Build & Platform
|
|
- [B1: Build Instructions](B1-build-instructions.md) - How to build yaze on Windows, macOS, and Linux.
|
|
- [B2: Platform Compatibility](B2-platform-compatibility.md) - Cross-platform support details.
|
|
- [B3: Build Presets](B3-build-presets.md) - A guide to the CMake preset system.
|
|
- [B4: Release Workflows](B4-release-workflows.md) - GitHub Actions release pipeline documentation.
|
|
- [B5: Architecture and Networking](B5-architecture-and-networking.md) - System architecture, gRPC, and networking.
|
|
|
|
## C: `z3ed` CLI
|
|
- [C1: `z3ed` Agent Guide](C1-z3ed-agent-guide.md) - The AI-powered command-line interface.
|
|
|
|
## E: Development & API
|
|
- [E1: Assembly Style Guide](E1-asm-style-guide.md) - 65816 assembly coding standards.
|
|
- [E2: Development Guide](E2-development-guide.md) - Core architectural patterns, UI systems, and best practices.
|
|
- [E3: API Reference](E3-api-reference.md) - C/C++ API documentation for extensions.
|
|
|
|
## F: Technical Documentation
|
|
- [F1: Dungeon Editor Guide](F1-dungeon-editor-guide.md) - A master guide to the dungeon editing system.
|
|
- [F2: Tile16 Editor Palette System](F2-tile16-editor-palette-system.md) - Design of the palette system.
|
|
- [F3: Overworld Loading](F3-overworld-loading.md) - How vanilla and ZSCustomOverworld maps are loaded.
|
|
|
|
## G: GUI Guides
|
|
- [G1: Canvas System and Automation](G1-canvas-guide.md) - The core GUI drawing and interaction system.
|
|
|
|
## H: Project Info
|
|
- [H1: Changelog](H1-changelog.md)
|
|
|
|
## I: Roadmap
|
|
- [I1: Roadmap](I1-roadmap.md)
|
|
|
|
---
|
|
|
|
*Last updated: October 2025 - Version 0.3.2* |