diff options
Diffstat (limited to 'lib')
-rw-r--r-- | lib/README.md | 25 |
1 files changed, 21 insertions, 4 deletions
diff --git a/lib/README.md b/lib/README.md index 209cac1..e4649aa 100644 --- a/lib/README.md +++ b/lib/README.md @@ -1,22 +1,26 @@ LZ4 - Library Files ================================ -All source material within __lib__ directory are BSD 2-Clause licensed. -See [LICENSE](LICENSE) for details. -The license is also repeated at the top of each source file. - The directory contains many files, but depending on project's objectives, not all of them are necessary. +#### Minimal LZ4 build + The minimum required is **`lz4.c`** and **`lz4.h`**, which will provide the fast compression and decompression algorithm. + +#### The High Compression variant od LZ4 + For more compression at the cost of compression speed, the High Compression variant **lz4hc** is available. It's necessary to add **`lz4hc.c`** and **`lz4hc.h`**. The variant still depends on regular `lz4` source files. In particular, the decompression is still provided by `lz4.c`. + +#### Compatibiliy issues + In order to produce files or streams compatible with `lz4` command line utility, it's necessary to encode lz4-compressed blocks using the [official interoperable frame format]. This format is generated and decoded automatically by the **lz4frame** library. @@ -26,10 +30,16 @@ which provides error detection. This is what `liblz4` does, to avoid symbol duplication in case a user program would link to several libraries containing xxhash symbols.) + +#### Advanced API + A more complex `lz4frame_static.h` is also provided. It contains definitions which are not guaranteed to remain stable within future versions. It must be used with static linking ***only***. + +#### Miscellaneous + Other files present in the directory are not source code. There are : - LICENSE : contains the BSD license text @@ -38,3 +48,10 @@ Other files present in the directory are not source code. There are : - README.md : this file [official interoperable frame format]: ../doc/lz4_Frame_format.md + + +#### License + +All source material within __lib__ directory are BSD 2-Clause licensed. +See [LICENSE](LICENSE) for details. +The license is also repeated at the top of each source file. |