From: Yann Collet <cyan@fb.com>
Date: Wed, 28 Feb 2018 01:37:05 +0000 (-0800)
Subject: update doc/README.md on provided tools to test 3rd party implementations
X-Git-Tag: v1.3.4~1^2~44
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=564cb1b640c753160b6655d95bae62d1f03f7781;p=thirdparty%2Fzstd.git

update doc/README.md on provided tools to test 3rd party implementations
---

diff --git a/doc/README.md b/doc/README.md
index 47cfe3617..1f01fa47d 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -2,19 +2,24 @@ Zstandard Documentation
 =======================
 
 This directory contains material defining the Zstandard format,
-as well as for help using the `zstd` library.
+as well as detailed instructions to use `zstd` library.
+
+__`zstd_manual.html`__ : Documentation of `zstd.h` API, in html format.
+Click on this link: [http://zstd.net/zstd_manual.html](http://zstd.net/zstd_manual.html)
+to display documentation of latest release in readable format within a browser.
 
 __`zstd_compression_format.md`__ : This document defines the Zstandard compression format.
 Compliant decoders must adhere to this document,
 and compliant encoders must generate data that follows it.
 
+Should you look for ressources to develop your own port of Zstandard algorithm,
+you may find the following ressources useful :
+
 __`educational_decoder`__ : This directory contains an implementation of a Zstandard decoder,
 compliant with the Zstandard compression format.
 It can be used, for example, to better understand the format,
-or as the basis for a separate implementation a Zstandard decoder/encoder.
-
-__`zstd_manual.html`__ : Documentation on the functions found in `zstd.h`.
-See [http://zstd.net/zstd_manual.html](http://zstd.net/zstd_manual.html) for
-the manual released with the latest official `zstd` release.
-
+or as the basis for a separate implementation of Zstandard decoder.
 
+[__`decode_corpus`__](https://github.com/facebook/zstd/tree/dev/tests#decodecorpus---tool-to-generate-zstandard-frames-for-decoder-testing) :
+This tool, stored in `/tests` directory, is able to generate random valid frames,
+which is useful if you wish to test your decoder and verify it fully supports the specification.