revi-archive/xz-archive
1
0
Fork 0
mirror of https://git.tukaani.org/xz.git synced 2024-04-04 12:36:23 +02:00
Code Activity

README: Update outdated sections.

Browse source
This commit is contained in:
Lasse Collin 2020-03-16 20:01:37 +02:00
parent 29aed815ad
commit a048e3a92d
1 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README
View file

@ -55,9 +55,11 @@ XZ Utils
Similarly, it is possible that some day there is a filter that will Similarly, it is possible that some day there is a filter that will
compress better than LZMA2. compress better than LZMA2.
XZ Utils doesn't support multithreaded compression or decompression XZ Utils supports multithreaded compression. XZ Utils doesn't support
yet. It has been planned though and taken into account when designing multithreaded decompression yet. It has been planned though and taken
the .xz file format. into account when designing the .xz file format. In the future, files
that were created in threaded mode can be decompressed in threaded
mode too.
1. Documentation 1. Documentation
@ -103,14 +105,13 @@ XZ Utils
and data type as Doxygen tags. These docs should be quite OK as and data type as Doxygen tags. These docs should be quite OK as
a quick reference. a quick reference.
I have planned to write a bunch of very well documented example There are a few example/tutorial programs that should help in
programs, which (due to comments) should work as a tutorial to getting started with liblzma. In the source package the examples
various features of liblzma. No such example programs have been are in "doc/examples" and in binary packages they may be under
written yet. "examples" in the same directory as this README.
For now, if you have never used liblzma, libbzip2, or zlib, I Since the liblzma API has similarities to the zlib API, some people
recommend learning the *basics* of the zlib API. Once you know that, may find it useful to read the zlib docs and tutorial too:
it should be easier to learn liblzma.
http://zlib.net/manual.html http://zlib.net/manual.html
http://zlib.net/zlib_how.html http://zlib.net/zlib_how.html