Update the links in the README files following github migration.

Also add a README.md file for easier online reading on github.
2 files changed
tree: aad756f19f7f01eaa42720703f0cc55db15ec9d4
  1. gflags/
  2. gtest/
  3. m4/
  4. man/
  5. packages/
  6. src/
  7. testdata/
  8. vsprojects/
  9. .gitignore
  10. aclocal.m4
  11. AUTHORS
  12. autogen.sh
  13. ChangeLog
  14. compile
  15. config.guess
  16. config.sub
  17. configure
  18. configure.ac
  19. CONTRIBUTORS
  20. COPYING
  21. depcomp
  22. INSTALL
  23. install-sh
  24. ltmain.sh
  25. Makefile.am
  26. Makefile.in
  27. missing
  28. mkinstalldirs
  29. NEWS
  30. README
  31. README.md
  32. THANKS
README.md

open-vcdiff README

open-vcdiff is an encoder and decoder for the VCDIFF format, as described in RFC 3284: The VCDIFF Generic Differencing and Compression Data Format.

A library with a simple API is included, as well as a command-line executable that can apply the encoder and decoder to source, target, and delta files. For further details, please refer to this link.

See INSTALL for (generic) installation instructions for C++: basically

./configure && make && make install

This should compile the unit tests as well as vcdiff, a simple command-line utility to run the encoder and decoder. Typical usage of vcdiff is as follows (the < and > are file redirect operations, not optional arguments):

vcdiff encode -dictionary file.dict < target_file > delta_file
vcdiff decode -dictionary file.dict < delta_file  > target_file

To see the command-line syntax of vcdiff, use vcdiff --help or just vcdiff.

To call the encoder from C++ code, assuming that dictionary, target, and delta are all std::string objects:

#include <google/vcencoder.h>  // Read this file for interface details

// [...]

open_vcdiff::VCDiffEncoder encoder(dictionary.data(), dictionary.size());
encoder.SetFormatFlags(open_vcdiff::VCD_FORMAT_INTERLEAVED);
encoder.Encode(target.data(), target.size(), &delta);

Calling the decoder is just as simple:

#include <google/vcdecoder.h>  // Read this file for interface details

// [...]

open_vcdiff::VCDiffDecoder decoder;
decoder.Decode(dictionary.data(), dictionary.size(), delta, &target);

When using the encoder, the C++ application must be linked with the library options -lvcdcom and -lvcdenc; when using the decoder, it must be linked with -lvcdcom and -lvcddec.

To verify that the package works on your system, especially after making modifications to the source code, please run the unit tests using make check.

For further details, please refer to this link.