From: inikep <inikep@gmail.com>
Date: Thu, 25 Aug 2016 06:47:18 +0000 (+0200)
Subject: improved tests/README.md
X-Git-Tag: v1.0.0^2~32^2~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7f18c6e5ef36e0c0e4921384c45502d726ac13fb;p=thirdparty%2Fzstd.git

improved tests/README.md
---

diff --git a/projects/README.md b/projects/README.md
index 96202c1cd..d724cdcba 100644
--- a/projects/README.md
+++ b/projects/README.md
@@ -16,8 +16,8 @@ The following projects are included with the zstd distribution:
 1. Install Visual Studio e.g. VS 2015 Community Edition (it's free).
 2. Download the latest version of zstd from https://github.com/Cyan4973/zstd/releases
 3. Decompress ZIP archive.
-4. Go to decompressed directory then to "projects" then "VS2010" and open zstd.sln
+4. Go to decompressed directory then to `projects` then `VS2010` and open `zstd.sln`
 5. Visual Studio will ask about converting VS2010 project to VS2015 and you should agree.
-6. Change "Debug" to "Release" and if you have 64-bit Windows change also "Win32" to "x64".
-7. Press F7 on keyboard or select "BUILD" from the menu bar and choose "Build Solution".
-8. If compilation will be fine a compiled executable will be in projects\VS2010\bin\x64\Release\zstd.exe
+6. Change `Debug` to `Release` and if you have 64-bit Windows change also `Win32` to `x64`.
+7. Press F7 on keyboard or select `BUILD` from the menu bar and choose `Build Solution`.
+8. If compilation will be fine a compiled executable will be in `projects\VS2010\bin\x64\Release\zstd.exe`
diff --git a/tests/Makefile b/tests/Makefile
index a8fb97c21..c054bbbb0 100644
--- a/tests/Makefile
+++ b/tests/Makefile
@@ -22,13 +22,17 @@
 #  - zstd homepage : http://www.zstd.net/
 # ##########################################################################
 # datagen : Synthetic and parametrable data generator, for tests
+# fullbench  : Precisely measure speed for each zstd inner functions
+# fullbench32: Same as fullbench, but forced to compile in 32-bits mode
 # fuzzer  : Test tool, to check zstd integrity on target platform
 # fuzzer32: Same as fuzzer, but forced to compile in 32-bits mode
+# paramgrill : parameter tester for zstd
+# test-zstd-speed.py : script for testing zstd speed difference between commits
+# versionsTest : compatibility test between zstd versions stored on Github (v0.1+)
 # zbufftest  : Test tool, to check ZBUFF integrity on target platform
 # zbufftest32: Same as zbufftest, but forced to compile in 32-bits mode
-# fullbench  : Precisely measure speed for each zstd inner function
-# fullbench32: Same as fullbench, but forced to compile in 32-bits mode
-# versionstest : Compatibility test between zstd versions stored on Github (v0.1+)
+# zstreamtest : Fuzzer test tool for zstd streaming API
+# zbufftest32: Same as zstreamtest, but forced to compile in 32-bits mode
 # ##########################################################################
 
 DESTDIR?=
diff --git a/tests/README.md b/tests/README.md
index 7b3795412..309638f91 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -1,6 +1,17 @@
-scripts for automated testing of zstd
+programs and scripts for automated testing of zstd
 ================================
 
+This directory contains the following programs and scripts:
+- datagen : Synthetic and parametrable data generator, for tests
+- fullbench  : Precisely measure speed for each zstd inner functions
+- fuzzer  : Test tool, to check zstd integrity on target platform
+- paramgrill : parameter tester for zstd
+- test-zstd-speed.py : script for testing zstd speed difference between commits
+- test-zstd-versions.py : compatibility test between zstd versions stored on Github (v0.1+)
+- zbufftest  : Test tool, to check ZBUFF integrity on target platform
+- zstreamtest : Fuzzer test tool for zstd streaming API
+
+
 #### test-zstd-versions.py - script for testing zstd interoperability between versions
 
 This script creates `versionsTest` directory to which zstd repository is cloned.
diff --git a/tests/zbufftest.c b/tests/zbufftest.c
index ce6beb246..151785c60 100644
--- a/tests/zbufftest.c
+++ b/tests/zbufftest.c
@@ -1,5 +1,5 @@
 /*
-    Fuzzer test tool for zstd_buffered
+    Fuzzer test tool for ZBUFF - a buffered streaming API for ZSTD
     Copyright (C) Yann Collet 2015-2016
 
     GPL v2 License