]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
updated lib/README.md part 2
authorinikep <inikep@gmail.com>
Mon, 25 Apr 2016 09:36:44 +0000 (11:36 +0200)
committerinikep <inikep@gmail.com>
Mon, 25 Apr 2016 09:36:44 +0000 (11:36 +0200)
lib/README.md

index 80e8b98de6bc060df3c1e27474499bc9e5edbf1b..6002118e0f10d821d369cf567e85ae11434586a4 100644 (file)
@@ -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