From cc8d30e677bcdbb8ca54f9efa98e0e953fb67d3a Mon Sep 17 00:00:00 2001
From: infval <38145742+infval@users.noreply.github.com>
Date: Tue, 14 Jul 2020 03:32:20 +0300
Subject: [PATCH] Create README.md

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fe0615a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# StrikeLZSS
+LZSS compressor & decompressor for *Desert Strike*, *Jungle Strike*, *Urban Strike* (Sega Mega Drive/Genesis).
+## Usage
+### Editing ROM
+Apply master code:
+```
+Desert Strike - 0FFFC4:4E71
+Jungle Strike - 1FF2E0:4E75
+ Urban Strike - 1FF0D4:4E75
+```
+### Searching compressed art
+Set the execution (PC) breakpoint at:
+```
+Desert Strike - $006112
+Jungle Strike - $04619C
+ Urban Strike - $00762A
+```
+When execution stops, register `A2` contains the offset in the ROM.
+### Program usage
+Decompress:
+```
+StrikeLZSS -d input.bin output.bin -p 0x12AB
+```
+-p OFFSET - the starting position in the input file (hex - 0xAB or dec - 171).
+
+Compress:
+```
+StrikeLZSS input.bin output.bin
+```