Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the readme look a bit better on GitHub #256

Open
wants to merge 1 commit into
base: release3_1_apl
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions xdelta3/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Xdelta 3.x readme.txt
=====================

Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
2009, 2010, 2011, 2012, 2013, 2014, 2015
<[email protected]>
Expand All @@ -10,27 +12,27 @@ This directory contains the Xdelta3 command-line interface (CLI) and source
distribution for VCDIFF differential compression, a.k.a. delta
compression. The latest information and downloads are available here:

http://xdelta.org/
http://github.com/jmacd/xdelta/
* http://xdelta.org/
* http://github.com/jmacd/xdelta/

Xdelta can be configured to use XZ Utils for secondary compression:

http://tukaani.org/xz/
* http://tukaani.org/xz/

The command-line syntax is detailed here:

https://github.com/jmacd/xdelta/blob/wiki/CommandLineSyntax.md
* https://github.com/jmacd/xdelta/blob/wiki/CommandLineSyntax.md

Run 'xdelta3 -h' for brief help. Run 'xdelta3 test' for built-in tests.

Sample commands (like gzip, -e means encode, -d means decode)

xdelta3 -9 -S lzma -e -f -s OLD_FILE NEW_FILE DELTA_FILE
xdelta3 -d -s OLD_FILE DELTA_FILE DECODED_FILE
xdelta3 -9 -S lzma -e -f -s OLD_FILE NEW_FILE DELTA_FILE
xdelta3 -d -s OLD_FILE DELTA_FILE DECODED_FILE

File bug reports and browse open support issues here:

https://github.com/jmacd/xdelta/issues
* https://github.com/jmacd/xdelta/issues

The source distribution contains the C/C++/Python APIs, Unix, Microsoft VC++
and Cygwin builds. Xdelta3 is covered under the terms of the APL, see
Expand Down