Skip to content

Commit d389f8a

Browse files
committed
docs: minor update
1 parent 26fb494 commit d389f8a

File tree

2 files changed

+13
-17
lines changed

2 files changed

+13
-17
lines changed

documentation/appendix.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ User supplied URL handlers
7777

7878
On Debian based systems, serial ports are usually in the group ``dialout``,
7979
so running ``sudo adduser $USER dialout`` (and logging-out and -in) enables
80-
the user to use the port.
80+
the user to access the port.
8181

8282

8383
Related software

documentation/pyserial.rst

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Requirements
5353
Installation
5454
============
5555

56-
pyserial
56+
pySerial
5757
--------
5858
This installs a package that can be used from Python (``import serial``).
5959

@@ -62,37 +62,33 @@ may be required.
6262

6363
From PyPI
6464
~~~~~~~~~
65-
pySerial can be installed from PyPI, either manually downloading the
66-
files and installing as described below or using::
65+
pySerial can be installed from PyPI::
6766

68-
pip install pyserial
67+
python -m pip install pyserial
6968

70-
or::
71-
72-
easy_install -U pyserial
69+
Using the `python`/`python3` executable of the desired version (2.x/3.x).
7370

7471
From source (tar.gz or checkout)
7572
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76-
Download the archive from http://pypi.python.org/pypi/pyserial.
73+
Download the archive from http://pypi.python.org/pypi/pyserial or
74+
https://github.com/pyserial/pyserial/releases.
7775
Unpack the archive, enter the ``pyserial-x.y`` directory and run::
7876

7977
python setup.py install
8078

81-
For Python 3.x::
82-
83-
python3 setup.py install
79+
Using the `python`/`python3` executable of the desired version (2.x/3.x).
8480

8581
Packages
8682
~~~~~~~~
8783
There are also packaged versions for some Linux distributions and Windows:
8884

8985
Debian/Ubuntu
90-
A package is available under the name "python-serial". Note that some
91-
distributions may package an older version of pySerial.
86+
A package is available under the name "python-serial" or similar. Note
87+
that some distributions may package an older version of pySerial.
9288

9389
Windows
94-
There is also a Windows installer for end users. It is located in the
95-
PyPi_. Developers also may be interested to get the source archive,
90+
There is a "wheel" file for end users. It is located in the PyPi_.
91+
Developers also may be interested to get the source archive,
9692
because it contains examples, tests and the this documentation.
9793

9894
.. _PyPi: http://pypi.python.org/pypi/pyserial
@@ -115,7 +111,7 @@ Older versions are still available in the old download_ page. pySerial 1.21
115111
is compatible with Python 2.0 on Windows, Linux and several un*x like systems,
116112
MacOSX and Jython.
117113

118-
On Windows releases older than 2.5 will depend on pywin32_ (previously known as
114+
On Windows, releases older than 2.5 will depend on pywin32_ (previously known as
119115
win32all)
120116

121117
.. _download: https://pypi.python.org/pypi/pyserial

0 commit comments

Comments
 (0)