scawful/yaze
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation and add index

Browse Source
This commit is contained in:
scawful
2025-09-25 00:02:38 -04:00
parent 7014d73e7b
commit a01200dd29
9 changed files with 1087 additions and 410 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -39,8 +39,18 @@ Dependencies are included as submodules and will be built automatically. For tho
## Documentation
- For users, please refer to [getting_started.md](docs/getting-started.md) for instructions on how to use yaze.
- For developers, please refer to the [documentation](https://scawful.github.io/yaze/index.html) for information on the project's infrastructure.
- **[Getting Started](docs/getting-started.md)** - Basic setup and usage guide
- **[Build Instructions](docs/build-instructions.md)** - Detailed build and installation guide
- **[Documentation Index](docs/index.md)** - Complete documentation overview
- **[Contributing](docs/contributing.md)** - How to contribute to the project
### Key Documentation
- **[Dungeon Editor Guide](docs/dungeon-editor-comprehensive-guide.md)** - Complete dungeon editing guide
- **[Overworld Loading Guide](docs/overworld_loading_guide.md)** - ZSCustomOverworld implementation
- **[Canvas Interface](docs/canvas-refactor-summary.md)** - Graphics system architecture
- **[Integration Tests](docs/integration_test_guide.md)** - Testing framework
For developers, see the [documentation index](docs/index.md) for a complete overview of all available documentation.
License
--------