Updated README.md

This commit is contained in:
Vincent Knight 2024-04-18 16:41:10 -05:00
parent 1472ff6da9
commit 9b91bb0c01

View file

@ -2,5 +2,45 @@
A CLI wrapper for the IPS crate.
You can patch a file using the following command:
`ips-rs -i <path/to/file.rom> -o <path/to/patch.ips>`
## Usage:
### Help
```
$ rhack
Patch/Rom hacking utility.
Usage: rhack <COMMAND>
Commands:
ips Uses IPS patching
xdelta Uses XDELTA patching
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
```
### Patching
```
$ rhack xdelta
Uses XDELTA patching
Usage: rhack xdelta [OPTIONS]
Options:
-i, --input-file <FILE> File to patch
-p, --patch-file <FILE> Patch file to use
-o, --output-file <FILE> Output file
-h, --help Print help
$ rhack ips
Uses IPS patching
Usage: rhack ips [OPTIONS]
Options:
-i, --input-file <FILE> File to patch
-p, --patch-file <FILE> Patch file to use
-o, --output-file <FILE> Output file
-h, --help Print help
```