Skip to content

Commit 81ac5bb

Browse files
committed
Documentation fix
1 parent d5b569e commit 81ac5bb

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

docs/install.rst

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ From source
1818
The latest stable version of *python-evdev* can be installed from pypi_,
1919
provided that you have a compiler, pip_ and the Python and Linux development
2020
headers installed on your system. Installing these is distribution specific and
21-
typically falls in one of the following:
21+
typically falls into one of the following:
2222

2323
On a Debian compatible OS:
2424

@@ -40,12 +40,21 @@ On Arch Linux and derivatives:
4040
4141
$ pacman -S core/linux-api-headers python-pip gcc
4242
43-
Once all dependencies are available, you may install *python-evdev* using pip_:
43+
Once all OS dependencies are available, you may install *python-evdev* using
44+
pip_, preferably in a [virtualenv]_:
4445

4546
.. code-block:: bash
4647
47-
$ sudo pip install evdev # available globally
48-
$ pip install --user evdev # available to the current user
48+
# Install globally (not recommended).
49+
$ sudo python3 -m pip install evdev
50+
51+
# Install for the current user.
52+
$ python3 -m pip install --user evdev
53+
54+
# Install in a virtual environment.
55+
$ python3 -m venv abc
56+
$ source abc/bin/activate
57+
$ python3 -m pip install evdev
4958
5059
5160
Specifying header locations
@@ -73,3 +82,4 @@ colon-separated paths. For example:
7382
.. _pip: http://pip.readthedocs.org/en/latest/installing.html
7483
.. _example: https://github.com/gvalkov/python-evdev/tree/master/examples
7584
.. _`async/await`: https://docs.python.org/3/library/asyncio-task.html
85+
.. _virtualenv: https://docs.python.org/3/library/venv.html

0 commit comments

Comments
 (0)