summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Endsley <mendsley@gmail.com>2012-10-23 18:39:48 -0700
committerMatthew Endsley <mendsley@gmail.com>2012-10-23 18:39:48 -0700
commitce07a29894acd74c52b975a42c02f11d9483566a (patch)
tree5f30853da89cd63fbf49505884115aa969720e5c
parent9807c0d4cdfaff3434429b8e4f45626909fd73cf (diff)
downloadbsdiff-ce07a29894acd74c52b975a42c02f11d9483566a.tar.gz
clarifying motivation for compat-breaking with bsdiffv4.3-endsley
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1dab98a..7997162 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,15 @@ dirty you can copy paste the header portion at the top of the file into your own
I've exposed relevant functions via the `_stream` classes. The only external
dependency not exposed is `memcmp` in `bsdiff`.
+This library generates patches that are not compatible with the original bsdiff
+tool. The impompatibilities were motivated by the patching needs for the game
+AirMech <https://www.carbongames.com> and the following requirements:
+
+* Eliminate/minimize any seek operations when applying patches
+* Eliminate any required disk I/O and support embedded streams
+* Ability to easily embed the routines as a library instead of an external binary
+* Compile+run on all platforms we use to build the game (Windows, Linux, NaCl, OSX)
+
Compiling
---------
The libraries should compile warning free in any moderately recent version of