summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorChris Liechti <cliechti@gmx.net>2015-08-08 20:54:49 +0200
committerChris Liechti <cliechti@gmx.net>2015-08-08 20:54:49 +0200
commite2c31194a29d7d89d890f619295711e823445d15 (patch)
treee710133fc50fe61795f31808ab3954f04438f4c9 /README.rst
parent977916f8c0e0a1be5cd0c909acc7212ba51d2154 (diff)
downloadpyserial-git-e2c31194a29d7d89d890f619295711e823445d15.tar.gz
doc update, remove obsolete .cvsignore
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index a427a57..e081698 100644
--- a/README.rst
+++ b/README.rst
@@ -5,7 +5,7 @@
Overview
========
This module encapsulates the access for the serial port. It provides backends
-for Python running on Windows, Linux, BSD (possibly any POSIX compliant
+for Python_ running on Windows, Linux, BSD (possibly any POSIX compliant
system), Jython and IronPython (.NET and Mono). The module named "serial"
automatically selects the appropriate backend.
@@ -19,12 +19,12 @@ Documentation
=============
For API documentation, usage and examples see files in the "documentation"
directory. The ".rst" files can be read in any text editor or being converted to
-HTML or PDF using Sphinx. An online HTML version is at
+HTML or PDF using Sphinx_. A HTML version is online at
https://pythonhosted.org/pyserial/
Examples
========
-Examples and unit tests are in the directory "examples".
+Examples and unit tests are in the directory examples_.
Installation
@@ -33,7 +33,10 @@ Installation
Detailed information can be found in `documentation/pyserial.rst`_.
-The usual setup.py for Python libraries is used for the source distribution.
+The usual setup.py for Python_ libraries is used for the source distribution.
Windows installers are also available (see download link above).
.. _`documentation/pyserial.rst`: https://github.com/pyserial/pyserial/blob/master/documentation/pyserial.rst#installation
+.. _examples: https://github.com/pyserial/pyserial/blob/master/examples
+.. _Python: http://python.org/
+.. _Sphinx: http://sphinx-doc.org/