Skip to content

Commit b0425eb

Browse files
committed
Readme: improve install instructions a bit.
1 parent 8e4acc1 commit b0425eb

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ News
5252
- _**Important note**: Python 2 support is deprecated and is planned to be dropped from an upcoming release._
5353
Existing releases of pyOCD will, of course, continue to work with Python 2. If this is a major problem for you
5454
moving forward, please create a [new issue](https://github.com/mbedmicro/pyOCD/issues/new/choose) describing
55-
your concerns.
55+
your concerns. As of 1 January 2021, there has been no negative feedback about dropping Python 2, so this will
56+
likely happen sooner rather than later.
5657

5758

5859
Requirements
@@ -102,32 +103,36 @@ The latest stable version of pyOCD may be installed via [pip](https://pip.pypa.i
102103
as follows:
103104

104105
```
105-
$ pip install -U pyocd
106+
$ python3 -mpip install -U pyocd
106107
```
107108

109+
_Note: depending on your system, you may need to use `python` instead of `python3`. The same applies if
110+
you are using Python 2.7 (but please see the note above about deprecation of Python 2 support in pyocd)._
111+
108112
The latest pyOCD package is available [on PyPI](https://pypi.python.org/pypi/pyOCD/) as well as
109113
[on GitHub](https://github.com/mbedmicro/pyOCD/releases).
110114

111115
To install the latest prerelease version from the HEAD of the master branch, you can do
112116
the following:
113117

114118
```
115-
$ pip install --pre -U git+https://github.com/mbedmicro/pyOCD.git
119+
$ python3 -mpip install --pre -U git+https://github.com/mbedmicro/pyOCD.git
116120
```
117121

118122
You can also install directly from the source by cloning the git repository and running:
119123

120124
```
121-
$ python setup.py install
125+
$ python3 setup.py install
122126
```
123127

124128
Note that, depending on your operating system, you may run into permissions issues running these commands.
125129
You have a few options here:
126130

127-
1. Under Linux, run with `sudo -H` to install pyOCD and dependencies globally. (Installing with sudo
128-
should never be required for macOS.)
129-
2. Specify the `--user` option to install local to your user.
130-
3. Run the command in a [virtualenv](https://virtualenv.pypa.io/en/latest/)
131+
1. Under Linux, run with `sudo -H` to install pyOCD and dependencies globally. On macOS, installing with sudo
132+
should never be required, although sometimes permissions can become modified such that installing without
133+
using sudo fails.
134+
3. Specify the `--user` option to install local to your user account.
135+
4. Run the command in a [virtualenv](https://virtualenv.pypa.io/en/latest/)
131136
local to a specific project working set.
132137

133138
For notes about installing and using on non-x86 systems such as Raspberry Pi, see the

0 commit comments

Comments
 (0)