Added README and screenshots.

This commit is contained in:
David Korth 2017-07-07 22:59:34 -04:00
parent 326deabcc2
commit 746a7cb271
3 changed files with 28 additions and 0 deletions

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# *** HACK DETECTION ***
This is a simple command line utility that can check if a ROM hack
appears to be a hex-edited binary hack instead of a hack based on
a disassembly.
## How to use:
```
$ hack-detection [Source ROM] [Hacked ROM]
```
* Source ROM: The original ROM, e.g. "Sonic 1 Rev00.gen".
* Hacked ROM: The hacked ROM, e.g. "Sonic 1337.bin".
## Screenshots
These examples use Sonic 1 Rev00 as the source ROM and
[Sonic 1337](https://info.sonicretro.org/Sonic_1337) as the hacked ROM.
![hack-detection on Windows XP](screenshots/hd-winxp.png)
![hack-detection on xterm (KDE5)](screenshots/hd-xterm.png)
## License
hack-detection is licensed under the GNU AGPLv3. See [LICENSE.md](LICENSE.md)
for more information.

BIN
screenshots/hd-winxp.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

BIN
screenshots/hd-xterm.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB