|
52 | 52 | - _**Important note**: Python 2 support is deprecated and is planned to be dropped from an upcoming release._ |
53 | 53 | Existing releases of pyOCD will, of course, continue to work with Python 2. If this is a major problem for you |
54 | 54 | 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. |
56 | 57 |
|
57 | 58 |
|
58 | 59 | Requirements |
@@ -102,32 +103,36 @@ The latest stable version of pyOCD may be installed via [pip](https://pip.pypa.i |
102 | 103 | as follows: |
103 | 104 |
|
104 | 105 | ``` |
105 | | -$ pip install -U pyocd |
| 106 | +$ python3 -mpip install -U pyocd |
106 | 107 | ``` |
107 | 108 |
|
| 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 | + |
108 | 112 | The latest pyOCD package is available [on PyPI](https://pypi.python.org/pypi/pyOCD/) as well as |
109 | 113 | [on GitHub](https://github.com/mbedmicro/pyOCD/releases). |
110 | 114 |
|
111 | 115 | To install the latest prerelease version from the HEAD of the master branch, you can do |
112 | 116 | the following: |
113 | 117 |
|
114 | 118 | ``` |
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 |
116 | 120 | ``` |
117 | 121 |
|
118 | 122 | You can also install directly from the source by cloning the git repository and running: |
119 | 123 |
|
120 | 124 | ``` |
121 | | -$ python setup.py install |
| 125 | +$ python3 setup.py install |
122 | 126 | ``` |
123 | 127 |
|
124 | 128 | Note that, depending on your operating system, you may run into permissions issues running these commands. |
125 | 129 | You have a few options here: |
126 | 130 |
|
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/) |
131 | 136 | local to a specific project working set. |
132 | 137 |
|
133 | 138 | For notes about installing and using on non-x86 systems such as Raspberry Pi, see the |
|
0 commit comments