From: stephan.thiele <redacted>
Date: Sat, 20 Oct 2018 15:23:23 +0000 (+0200)
Subject: README: improve pdtest documentation
X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-test.git;a=commitdiff_plain;h=eb7f7eff3c04cac2dfc84990cf2b487e95a31ee4

README: improve pdtest documentation
---

diff --git a/README b/README
index 85784b2..962658a 100644
--- a/README
+++ b/README
@@ -71,12 +71,22 @@ accordingly. Some notes:
    Of important note, the channels/probes are numbered from 0, regardless of
    the naming used in the capture file.
 
+ * To initially generate the test files which have been configured in test.conf
+   pdtest has to be run with the -f parameter first.
+
+   Example:
+
+    ./decoder/pdtest -r -v -f <testroot>
+
+  This can also be done to update the test-cases in case of a changes in
+  the protocol decoder.
+
  * To troubleshoot a specific test, try:
 
     * Run all tests under decoder/test/<testroot>:
 
       ./decoder/pdtest -v -d -r <testroot>
-  
+
     * Run the named test. Note, in this case <testname> is not
       a file but rather a test described in <testroot>/test.conf.