From: W. Trevor King Date: Thu, 17 Jan 2013 22:51:28 +0000 (-0500) Subject: README: Double-backtick code for proper ReST markup X-Git-Tag: 0.7~2 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=d07922f62760794863af55efb887283bd8982b8c;p=pycomedi.git README: Double-backtick code for proper ReST markup --- diff --git a/README b/README index 984d43b..fbeb14c 100644 --- a/README +++ b/README @@ -1,14 +1,14 @@ This package provides an object-oriented interface to the Comedi_ drivers. The standard Python interface bundled with Comedilib is a simple SWIG clone of the C interface. In pycomedi, we convert the -functions into class methods (see `pycomedi.classes`), so you don't -have to worry about dragging around opaque types like `comedi_t *` +functions into class methods (see ``pycomedi.classes``), so you don't +have to worry about dragging around opaque types like ``comedi_t *`` device pointers. We also bundle related constants together in -`_Enums` and `_Flags` (see `pycomedi.constants`), to make handling -common operations like flag manipulations simpler. Finally, there are -a number of utility classes (see `pycomedi.utility`) to make common -tasks like creating instructions or reading hardware-timed analog -input easier. +``_Enums`` and ``_Flags`` (see ``pycomedi.constants``), to make +handling common operations like flag manipulations simpler. Finally, +there are a number of utility classes (see ``pycomedi.utility``) to +make common tasks like creating instructions or reading hardware-timed +analog input easier. Installation @@ -71,7 +71,7 @@ standard:: Usage ===== -See the examples in the `doc` directory. +See the examples in the ``doc`` directory. Testing