Update README.md

This commit is contained in:
Luke Street 2024-05-15 19:01:55 -06:00
parent db726a68a6
commit 660e6c879e

View File

@ -16,7 +16,7 @@ Features:
Supports: Supports:
- PowerPC 750CL (GameCube & Wii) - PowerPC 750CL (GameCube & Wii)
- MIPS (Nintendo 64 & PS2) - MIPS (Nintendo 64 & PS2)
- x86 (PE only at the moment) - x86 (COFF only at the moment)
See [Usage](#usage) for more information. See [Usage](#usage) for more information.
@ -60,8 +60,8 @@ file as well. You can then add `objdiff.json` to your `.gitignore` to prevent it
{ {
"custom_make": "ninja", "custom_make": "ninja",
"custom_args": [ "custom_args": [
"-C", "-d",
"build" "keeprsp"
], ],
// Only required if objects use "path" instead of "target_path" and "base_path". // Only required if objects use "path" instead of "target_path" and "base_path".
@ -96,7 +96,10 @@ file as well. You can then add `objdiff.json` to your `.gitignore` to prevent it
``` ```
`custom_make` _(optional)_: By default, objdiff will use `make` to build the project. `custom_make` _(optional)_: By default, objdiff will use `make` to build the project.
If the project uses a different build system (e.g. `ninja`), specify it here. If the project uses a different build system (e.g. `ninja`), specify it here.
The build command will be `[custom_make] [custom_args] path/to/object.o`.
`custom_args` _(optional)_: Additional arguments to pass to the build command prior to the object path.
`target_dir` _(optional)_: Relative from the root of the project, this where the "target" or "expected" objects are located. `target_dir` _(optional)_: Relative from the root of the project, this where the "target" or "expected" objects are located.
These are the **intended result** of the match. These are the **intended result** of the match.