From: inikep Date: Mon, 25 Apr 2016 09:36:44 +0000 (+0200) Subject: updated lib/README.md part 2 X-Git-Tag: v0.6.1^2~39^2~9 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a8138fd767f8fa568ad97ea7e52d5303ce3012f0;p=thirdparty%2Fzstd.git updated lib/README.md part 2 --- diff --git a/lib/README.md b/lib/README.md index 80e8b98de..6002118e0 100644 --- a/lib/README.md +++ b/lib/README.md @@ -15,7 +15,7 @@ To build the zstd library the following files are required: - common/huf.h - common/huf_static.h - [common/mem.h](common/mem.h) -- [common/zstd.h](common/zstd.h) +- [common/zstd.h] - common/zstd_internal.h - common/zstd_static.h - compress/fse_compress.c @@ -26,16 +26,18 @@ To build the zstd library the following files are required: - 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, +Stable API is exposed in [common/zstd.h]. +Advanced and experimental API is exposed in `common/zstd_static.h`. +`common/zstd_static.h` API elements should be used with static linking only, as their definition may change in future version of the library. +[common/zstd.h]: common/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. +To build a separate zstd compressor all files from `common/` and `compressor/` directories are required. +In a similar way to build a separate zstd decompressor all files from `common/` and `decompressor/` directories are needed. #### Buffered streaming