updated to v1.03

Author: gitendo

README.md

@@ -1,22 +1,40 @@
-# isx2gb v1.02
+# isx2gb v1.03
 
-Command line utility to convert Intelligent Systems eXecutable files into Game Boy ROM format. This is my personal replacement for abISX v1.02 by Anaerob. It has following features:
+Command line utility to convert Intelligent Systems eXecutable files into Game Boy ROM format and more. This is my personal replacement for abISX v1.02 by Anaerob. It has following improvements:
 
 - code / data overflow in bank 0 is allowed, excess bytes are moved to bank 1 without any fuss.
-- you're not forced to ORG your code/data if you don't need to, just GROUP it in appropriate banks.
-- you can ORG your code in RAM or SRAM (why not?) and use `-r` option to save it to file for further processing. This might be appreciated by ROM hackers while generating series of patches.
-- to create symbolic file use CAPSOFF/SMALL with PUBALL directives in your source(s).
+- you're not forced to ORG your code / data if you don't need to, just GROUP it in appropriate banks.
+- you can ORG your code to RAM or SRAM (why not?) and save it to file(s) for further processing. This might be appreciated by clever coders or when size does matter.
+- you can patch Game Boy ROM on the fly exploiting ISX file as [IPS](http://justsolve.archiveteam.org/wiki/IPS_(binary_patch_format)) replacement. All the code / data will be applied to proper offsets.
+- creating symbolic file is easy, just use CAPSOFF/SMALL with PUBALL directives in your source(s).
 - ROM checksums are fixed automagically providing that there's a valid logo in header section.
-- ROM map is more readable.
+- more readable ROM map.
 
-### Options :
+### Options : 
 ```
--f  switch ROM filling pattern to 0xFF
--p  round up ROM size to the next highest power of 2
--r  save isx records separately
+⚠ there were changes from 1.02 to 1.03
+
+-d  dump isx records into binary file(s)
+-f  switch ROM filling pattern from 0x00 to 0xFF
+-p  patch supplied ROM file with ISX records
+-r  round up ROM size to the next highest power of 2
 -s  create symbolic file for debugger
 ```
 
+### Examples :
+```
+isx2gb -d code.isx
+```
+This will save all ORG sections into separate binary files, no ROM file is created. If you're into 128B/256B/1K/etc. coding, try to place your code in WRAM and compress such output for better result.
+```
+isx2gb -p patch.isx romfile.gbc
+```
+Patch `romfile.gbc` with code / data from `patch.isx` which basically works like `.ips` patching you're most likely familiar with. Take a look at my [Macross 7 english translation](https://github.com/gitendo/bm7j) for a proof of concept.
+```
+isx2gb -f -r -s game.isx
+```
+Create ROM file which will have free space filled with 0xFF instead of 0x00 (default). Round it to proper size, just like commercial stuff and produce symbolic file to be used with debugger ie. [BGB](http://bgb.bircd.org/).
+
 ### Important :
 Let me know if you see similar message:
 ```
@@ -26,8 +44,7 @@ Currently only record types 0x01, 0x13, 0x14, 0x20, 0x21, 0x22 are supported and
 
 ### To do :
 - improve rom padding option
-- clean up code / comments
 - test it thoroughly
 
 ### Bugs :
-I've fixed every one I found. Let me know if there's any more.
+Let me know if there's any.