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

update documentation links

Browse Source
This commit is contained in:
scawful
2024-08-11 12:03:09 -04:00
parent 6201aa963d
commit c07114ebbb
3 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/asm-style-guide.md
View File

@@ -4,7 +4,7 @@
This guide is based primarily on the [Oracle of Secrets](https://github.com/scawful/Oracle-of-Secrets) codebase and is meant for the [Asar](https://github.com/RPGHacker/asar) assembler and derives influence from the [Asar 1.9 Manual](https://rpghacker.github.io/asar/asar_19/manual/). This guide is based primarily on the [Oracle of Secrets](https://github.com/scawful/Oracle-of-Secrets) codebase and is meant for the [Asar](https://github.com/RPGHacker/asar) assembler and derives influence from the [Asar 1.9 Manual](https://rpghacker.github.io/asar/asar_19/manual/).
Custom assembly code applied to the game should be included through the [yaze.asm](../assets/asm/yaze.asm) file. This file can be applied to the ROM by the editor using the Asar library or included into a projects codebase for use with the Asar assembler. Custom assembly code applied to the game should be included through the `yaze.asm` file found in `assets/asm`. This file can be applied to the ROM by the editor using the Asar library or included into a projects codebase for use with the Asar assembler.
## Table of Contents ## Table of Contents

6
docs/contributing.md
View File

@@ -16,7 +16,7 @@ Objective-C Code should follow the [Google Objective-C Style Guide](https://goog
Python Code should follow the [PEP 8 Style Guide](https://pep8.org/). Python Code should follow the [PEP 8 Style Guide](https://pep8.org/).
Assembly code should follow the [65816 Style Guide](asm-style-guide.md). Assembly code should follow the [65816 Style Guide](docs/asm-style-guide.md).
## Key Areas of Contribution ## Key Areas of Contribution
@@ -82,7 +82,7 @@ Quality assurance and documentation are critical to yaze's success. Contribution
## Building the Project ## Building the Project
For detailed instructions on building YAZE, including its dependencies and supported platforms, refer to `build-instructions.md`. For detailed instructions on building YAZE, including its dependencies and supported platforms, refer to [build-instructions.md](docs/build-instructions.md).
## Getting Started ## Getting Started
@@ -101,7 +101,7 @@ git submodule update --init --recursive
3. Build the Project: 3. Build the Project:
Follow the instructions in the `build-instructions.md` file to configure and build the project on your target platform. Follow the instructions in the [build-instructions.md](docs/build-instructions.md). file to configure and build the project on your target platform.
4. Run the Application: 4. Run the Application:

2
docs/infrastructure.md
View File

@@ -31,7 +31,7 @@ The goal of yaze is to build a cross platform editor for the Legend of Zelda: A
## Dependencies ## Dependencies
See [build-instructions.md](../docs/build-instructions.md) for more information. See [build-instructions.md](docs/build-instructions.md) for more information.
- **SDL2**: Graphics library - **SDL2**: Graphics library
- **ImGui**: GUI library - **ImGui**: GUI library