From: inikep <inikep@gmail.com>
Date: Mon, 25 Apr 2016 09:31:28 +0000 (+0200)
Subject: updated lib/README.md
X-Git-Tag: v0.6.1^2~39^2~10
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=49794316c2cb290e5082c16490c20406bf30b4c8;p=thirdparty%2Fzstd.git

updated lib/README.md
---

diff --git a/lib/README.md b/lib/README.md
index ef446427a..80e8b98de 100644
--- a/lib/README.md
+++ b/lib/README.md
@@ -5,53 +5,58 @@ The __lib__ directory contains several files, but depending on target use case,
 
 #### Minimal library files
 
-##### Shared ressources
-
-- [mem.h](mem.h)
-- [error_private.h](error_private.h)
-- [error_public.h](error_public.h)
-
-##### zstd core compression
+To build the zstd library the following files are required:
+
+- [common/bitstream.h](common/bitstream.h)
+- [common/error_private.h](common/error_private.h)
+- [common/error_public.h](common/error_public.h)
+- common/fse.h
+- common/fse_static.h
+- common/huf.h
+- common/huf_static.h
+- [common/mem.h](common/mem.h)
+- [common/zstd.h](common/zstd.h)
+- common/zstd_internal.h
+- common/zstd_static.h
+- compress/fse_compress.c
+- compress/huf_compress.c
+- compress/zstd_compress.c
+- compress/zstd_opt.h 
+- decompress/fse_decompress.c
+- decompress/huf_decompress.c
+- decompress/zstd_decompress.c
 
 Stable API is exposed in [zstd.h].
 Advanced and experimental API is exposed in `zstd_static.h`.
 `zstd_static.h` API elements should be used with static linking only,
 as their definition may change in future version of the library.
 
-- [bitstream.h](bitstream.h)
-- fse.c
-- fse.h
-- fse_static.h
-- huf.c
-- huf.h
-- huf_static.h
-- zstd_compress.c
-- zstd_decompress.c
-- zstd_internal.h
-- zstd_opt.h
-- [zstd.h]
-- zstd_static.h
-
-[zstd.h]: zstd.h
+
+#### Separate compressor and decompressor
+
+To build a separate zstd compressor all files from common/ and compressor/ directories are required.
+In similar way to build a separate zstd decompressor all files from common/ and decompressor/ directories are needed.
+
 
 #### Buffered streaming
 
 This complementary API makes streaming integration easier.
 It is used by `zstd` command line utility, and [7zip plugin](http://mcmilk.de/projects/7-Zip-ZStd) :
 
-- zbuff.c
-- zbuff.h
-- zbuff_static.h
+- common/zbuff.h
+- common/zbuff_static.h
+- compress/zbuff_compress.c
+- decompress/zbuff_decompress.c
 
 #### Dictionary builder
 
 To create dictionaries from training sets :
 
-- divsufsort.c
-- divsufsort.h
-- zdict.c
-- zdict.h
-- zdict_static.h
+- dictBuilder/divsufsort.c
+- dictBuilder/divsufsort.h
+- dictBuilder/zdict.c
+- dictBuilder/zdict.h
+- dictBuilder/zdict_static.h
 
 #### Miscellaneous