diff options
author | Chris Liechti <cliechti@gmx.net> | 2015-08-04 03:32:02 +0200 |
---|---|---|
committer | Chris Liechti <cliechti@gmx.net> | 2015-08-04 03:32:02 +0200 |
commit | 90570b9a7d663e52bdf70b6a6b877bfd3246521e (patch) | |
tree | a8f6ff00819025b355caf9228bf34f18bb7e7139 /README.rst | |
parent | 70b892395deeaf3dc4967bd808101e61e4e1a53f (diff) | |
download | pyserial-git-90570b9a7d663e52bdf70b6a6b877bfd3246521e.tar.gz |
doc update: links, remove pyparallel page, rename README.txt to end in .rst
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..91a2049 --- /dev/null +++ b/README.rst @@ -0,0 +1,37 @@ +========== + pySerial +========== + +Overview +======== +This module encapsulates the access for the serial port. It provides backends +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. + +- Project Homepage: https://github.com/pyserial/pyserial +- Download Page: https://pypi.python.org/pypi/pyserial + +BSD license, (C) 2001-2015 Chris Liechti <cliechti@gmx.net> + + +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 +https://pythonhosted.org/pyserial/ + +Examples +======== +Examples and unit tests are in the directory "examples". + + +Installation +============ +``pip install pyserial`` should work for most users. + +Detailed information can be found in "documentation/pyserial.rst". + +The usual setup.py for Python libraries is used for the source distribution. +Windows installers are also available (see download link above). |