Skip to content

Commit ce07a29

Browse files
committed
clarifying motivation for compat-breaking with bsdiff
1 parent 9807c0d commit ce07a29

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,15 @@ dirty you can copy paste the header portion at the top of the file into your own
4242
I've exposed relevant functions via the `_stream` classes. The only external
4343
dependency not exposed is `memcmp` in `bsdiff`.
4444

45+
This library generates patches that are not compatible with the original bsdiff
46+
tool. The impompatibilities were motivated by the patching needs for the game
47+
AirMech <https://www.carbongames.com> and the following requirements:
48+
49+
* Eliminate/minimize any seek operations when applying patches
50+
* Eliminate any required disk I/O and support embedded streams
51+
* Ability to easily embed the routines as a library instead of an external binary
52+
* Compile+run on all platforms we use to build the game (Windows, Linux, NaCl, OSX)
53+
4554
Compiling
4655
---------
4756
The libraries should compile warning free in any moderately recent version of

0 commit comments

Comments
 (0)