summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYann Collet <yann.collet.73@gmail.com>2015-03-31 08:44:56 (GMT)
committerYann Collet <yann.collet.73@gmail.com>2015-03-31 08:44:56 (GMT)
commitf17496423cb7ca9be9d9d855fefcf78fbb70439a (patch)
treeaf9924fc11b72468f7debf136642cc5cf7dab032 /README.md
parent880381c11bc9838b8609643dff64044fca8856e2 (diff)
downloadlz4-f17496423cb7ca9be9d9d855fefcf78fbb70439a.zip
lz4-f17496423cb7ca9be9d9d855fefcf78fbb70439a.tar.gz
lz4-f17496423cb7ca9be9d9d855fefcf78fbb70439a.tar.bz2
Added : Frame documentation in MarkDown format
Diffstat (limited to 'README.md')
-rwxr-xr-x[-rw-r--r--]README.md38
1 files changed, 29 insertions, 9 deletions
diff --git a/README.md b/README.md
index 0f2cd40..69f7397 100644..100755
--- a/README.md
+++ b/README.md
@@ -1,8 +1,15 @@
LZ4 - Extremely fast compression
================================
-LZ4 is lossless compression algorithm, providing compression speed at 400 MB/s per core, scalable with multi-cores CPU. It also features an extremely fast decoder, with speed in multiple GB/s per core, typically reaching RAM speed limits on multi-core systems.
-A high compression derivative, called LZ4_HC, is also provided. It trades CPU time for compression ratio.
+LZ4 is lossless compression algorithm,
+providing compression speed at 400 MB/s per core,
+scalable with multi-cores CPU.
+It also features an extremely fast decoder,
+with speed in multiple GB/s per core,
+typically reaching RAM speed limits on multi-core systems.
+
+A high compression derivative, called LZ4_HC, is also provided.
+It trades CPU time for compression ratio.
|Branch |Status |
|------------|---------|
@@ -13,16 +20,21 @@ A high compression derivative, called LZ4_HC, is also provided. It trades CPU ti
> **Branch Policy:**
> - The "master" branch is considered stable, at all times.
-> - The "dev" branch is the one where all contributions must be merged before being promoted to master.
-> - If you plan to propose a patch, please commit into the "dev" branch. Direct commit to "master" are not permitted.
-> - Feature branches can also exist, for dedicated testing of larger modifications before merge into "dev" branch.
+> - The "dev" branch is the one where all contributions must be merged
+ before being promoted to master.
+> + If you plan to propose a patch, please commit into the "dev" branch.
+ Direct commit to "master" are not permitted.
+> - Feature branches can also exist,
+ for dedicated tests of larger modifications before merge into "dev" branch.
Benchmarks
-------------------------
-The benchmark uses the [Open-Source Benchmark program by m^2 (v0.14.3)](http://encode.ru/threads/1371-Filesystem-benchmark?p=33548&viewfull=1#post33548) compiled with GCC v4.8.2 on Linux Mint 64-bits v17.
+The benchmark uses the [Open-Source Benchmark program by m^2 (v0.14.3)]
+compiled with GCC v4.8.2 on Linux Mint 64-bits v17.
The reference system uses a Core i5-4300U @1.9GHz.
-Benchmark evaluates the compression of reference [Silesia Corpus](http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia) in single-thread mode.
+Benchmark evaluates the compression of reference [Silesia Corpus]
+in single-thread mode.
| Compressor | Ratio | Compression | Decompression |
| ---------- | ----- | ----------- | ------------- |
@@ -40,7 +52,15 @@ Benchmark evaluates the compression of reference [Silesia Corpus](http://sun.aei
|**LZ4 HC (r129)** |**2.720**| 22 MB/s | **1830 MB/s** |
| zlib 1.2.8 -6 | 3.099 | 18 MB/s | 270 MB/s |
-The LZ4 block compression format is detailed within [lz4_Block_format](lz4_Block_format.md).
+The LZ4 block compression format is detailed within [lz4_Block_format].
-For streaming unknown amount of data and compress files of any size, a frame format has been published, and can be consulted within the file LZ4_Frame_Format.html .
+Block format doesn't deal with header information,
+nor how to handle arbitrarily long files or data streams.
+This is the purpose of the Frame format.
+Interoperable versions of LZ4 should use the same frame format,
+defined into [lz4_Frame_format].
+[Open-Source Benchmark program by m^2 (v0.14.3)]: http://encode.ru/threads/1371-Filesystem-benchmark?p=34029&viewfull=1#post34029
+[Silesia Corpus]: http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia
+[lz4_Block_format]: lz4_Block_format.md
+[lz4_Frame_format]: lz4_Frame_format.md \ No newline at end of file