pylibftdi / doc / quickstart.rst

Diff from to

doc/quickstart.rst

 Though hopefully with a different serial number, or else you've either
 stolen mine, or you are me...
 
-Test some actual IO (well, at least O)
---------------------------------------
+Test some actual IO
+-------------------
+
+Output example
+~~~~~~~~~~~~~~
 
 Connect an LED between D0 of your bit-bang capable device and ground, via a
 330 - 1K ohm resistor as appropriate.
     $ python -m pylibftdi.examples.led_flash
 
 The LED should now flash at approximately 1Hz.
+
+Input example
+~~~~~~~~~~~~~
+
+To test some input, remove any connections from the port lines initially,
+then run the following, which reads and prints the status of the input lines
+regularly::
+
+    $ python -m pylibftdi.examples.pin_read
+
+The ``pin_read`` example is a complete command line application which can
+be used to monitor for particular values on the attached device pins, and
+output an appropriate error code on match. Repeat the above with a trailing
+``--help`` for info.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.