diff options
author | Matthew Endsley <mendsley@gmail.com> | 2012-05-14 16:14:54 -0700 |
---|---|---|
committer | Matthew Endsley <mendsley@gmail.com> | 2012-05-14 16:25:18 -0700 |
commit | a900bc05acfb2a6074a2abf8d9880b8ce0cae4af (patch) | |
tree | 889b5cd6a51f396cfd4246169075be646d931d70 | |
parent | 535b18fa8ffd3bff4e1c65d41851a98def58dd43 (diff) | |
download | bsdiff-a900bc05acfb2a6074a2abf8d9880b8ce0cae4af.tar.gz |
adding compiling section to README.md
-rw-r--r-- | README.md | 15 |
1 files changed, 14 insertions, 1 deletions
@@ -34,7 +34,7 @@ The overarching goal was to modify the original bsdiff/bspatch code from Colin and eliminate external dependencies and provide a simple interface to the core functionality. -You can defined `BSDIFF_HEADER_ONLY` or `BSPATCH_HEADER_ONLY` to only include +You can define `BSDIFF_HEADER_ONLY` or `BSPATCH_HEADER_ONLY` to only include the header parts of the file. If including a `.c` file makes you feel really dirty you can copy paste the header portion at the top of the file into your own `.h` file. @@ -42,6 +42,19 @@ 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`. +Compiling +--------- +The libraries should compile warning free in any moderately recent version of +gcc. The project uses `<stdint.h>` which is technically a C99 file and not +available in Microsoft Visual Studio. The easiest solution here is to use the +msinttypes version of stdint.h from <https://code.google.com/p/msinttypes/>. +The direct link for the lazy people is: +<https://msinttypes.googlecode.com/svn/trunk/stdint.h>. + +If your compiler does not provide an implementation of `<stdint.h>` you can +remove the header from the bsdiff/bspatch files and provide your own typedefs +for the following symbols: `uint8_t`, `uint64_t` and `int64_t`. + Examples -------- Each project has an optional main function that serves as an example for using |