diff --git a/README.md b/README.md new file mode 100644 index 0000000..b1ce98c --- /dev/null +++ b/README.md @@ -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. diff --git a/screenshots/hd-winxp.png b/screenshots/hd-winxp.png new file mode 100644 index 0000000..ad6c13e Binary files /dev/null and b/screenshots/hd-winxp.png differ diff --git a/screenshots/hd-xterm.png b/screenshots/hd-xterm.png new file mode 100644 index 0000000..5b8ad7c Binary files /dev/null and b/screenshots/hd-xterm.png differ