diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 705d42f3..8b2ebb4c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,6 +15,8 @@ repos: - id: mixed-line-ending - id: requirements-txt-fixer - id: trailing-whitespace + args: + - --markdown-linebreak-ext=md - repo: https://github.com/pre-commit/mirrors-clang-format rev: v19.1.5 diff --git a/docs/build_system.md b/docs/build_system.md index 82d32c6b..8b40d3ab 100644 --- a/docs/build_system.md +++ b/docs/build_system.md @@ -32,7 +32,7 @@ files to the project. Each `delinks.txt` file belongs to one module, such as the ARM9 program, the ITCM, the DTCM or an overlay. > [!NOTE] -> For interested readers: +> For interested readers: > All modules are loaded into RAM. This is different from the DS predecessor, the Game Boy Advance (GBA), in which all code was > simply on the ROM at all times. As a result, the GBA's RAM only consisted of variable data. > diff --git a/docs/decompiling.md b/docs/decompiling.md index 6eb32c39..c572e6f2 100644 --- a/docs/decompiling.md +++ b/docs/decompiling.md @@ -24,9 +24,9 @@ We use the object diffing tool [`objdiff`](https://github.com/encounter/objdiff) 1. [Download the latest release.](https://github.com/encounter/objdiff/releases/latest) 1. Run `configure.py ` and `ninja` to generate `objdiff.json` in the repository root. 1. In `objdiff`, set the project directory to the repository root. -1. Select your source file in the left sidebar: +1. Select your source file in the left sidebar: ![List of objects in objdiff](images/objdiff_objects.png) -5. See the list of functions and data to decompile: +5. See the list of functions and data to decompile: ![List of symbols in objdiff](images/objdiff_symbols.png) > [!NOTE]