Skip to content

Commit 59882ab

Browse files
author
Amanda Butler
authored
Merge pull request #554 from cmonr/py3-compat
Introduced docs changes to indicate Python 3 compatability
2 parents 103ad09 + ede1f6a commit 59882ab

File tree

3 files changed

+35
-10
lines changed

3 files changed

+35
-10
lines changed

docs/tools/offline/cli-setup.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,14 @@ You can install Mbed CLI on Windows, Linux and Mac OS X.
77
## Requirements
88

99
- **Python:** Mbed CLI is a Python script, so you'll need Python to use it:
10-
- We test Mbed CLI with [version 2.7.11 of Python](https://www.python.org/downloads/release/python-2711/). It is not compatible with Python 3.
10+
- We test Mbed CLI with [Python versions 2.7.11+ and 3.6.5+](https://www.python.org/downloads/).
1111
- pip.
12+
13+
<span class="notes">**Note:** Python 3 usage is **not compatible** with Mbed OS versions older than 5.9 and Mbed CLI toolchain versions older than 1.7.2. </span>
1214

1315
<span class="notes">**Note:** Mbed CLI toolchain versions older than 1.5.1 are **not compatible** with `pip` version 10.0 (or newer). Please use the latest Mbed CLI with newer version of `pip`.</span>
1416

17+
1518
- **Git and Mercurial:** Mbed CLI supports both Git and Mercurial repositories, and you may need libraries from both sources as you work, so please to install both:
1619
- [Git](https://git-scm.com/) - version 1.9.5 or later.
1720
- [Mercurial](https://www.mercurial-scm.org/) - version 2.2.2 or later.

docs/tools/testing/greentea.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This document should help you start using Greentea. Please see the [`htrun` docu
1010

1111
### Prerequisites
1212

13-
Greentea requires [Python version 2.7](https://www.python.org/downloads/). It supports the following OSes:
13+
Greentea requires [Python versions 2.7.11+ or 3.6.5+](https://www.python.org/downloads/). It supports the following OSes:
1414

1515
- Windows.
1616
- Linux (Ubuntu preferred).

docs/tutorials/quickstart/quick-start-cli.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,39 @@ The setup process for Arm Mbed CLI depends on your operating system. Please choo
88

99
#### Windows
1010

11-
##### 1. Install Mbed CLI
11+
Two installation methods are available for Windows. The first is a prebuilt installer that you can use quickly. The second installation method is more flexible and allows for greater customization to better fit your system's needs.
12+
13+
##### Prebuilt Mbed CLI installer
1214

1315
Download and run the [Mbed CLI Windows .exe installer](https://mbed-media.mbed.com/filer_public/50/38/5038849b-16a8-42f3-be7a-43d98c7a3af3/mbed_installer_v043.exe).
1416

1517
You can ensure Mbed CLI installed correctly by running `mbed help` from your command-line.
1618

1719
<span class="notes">**Note:** The Windows installer only installs the GNU Arm embedded toolchain. If you want to compile using Arm Compiler 5 or IAR, visit the [supported compilers page](/docs/latest/tools/index.html#compiler-versions).</span>
1820

21+
#### Manual installation
22+
23+
###### 1. Download and install Python and Pip
24+
25+
Download and install [Python versions 2.7.11+ or 3.6.5+](https://www.python.org/downloads/windows/) for Windows. Both Python versions come with their own version of Pip.
26+
27+
<span class="notes">**Note:** When the installer launches, check the checkbox that says **Add Python X.Y to PATH**. Otherwise, Windows does not know where to search for the Python executable.</span>
28+
29+
###### 2. Install a compiler
30+
31+
Download and install a compiler.
32+
33+
<span class="notes">**Note:** To download the latest toolchains, visit the [supported compilers page](/docs/development/tools/index.html#compiler-versions).</span>
34+
35+
###### 3. Install Mbed CLI
36+
37+
To install Mbed CLI, run `pip install mbed-cli` from your command-line.
38+
39+
You can ensure Mbed CLI installed correctly by running `mbed --version`.
40+
1941
##### 2. Setup environment
2042

21-
For any installed toolchain, be sure to add the Mbed CLI global configuration:
43+
After installation is complete, be sure to add any available toolchains to Mbed CLI's global configuration. Below is an example using the ARM compiler:
2244

2345
```
2446
> mbed config -G ARM_PATH <path to ARM bin\>"
@@ -36,7 +58,7 @@ ARM_PATH=<path to ARM bin\>
3658

3759
##### 1. Install Python and Pip
3860

39-
Mac OS X 10.8+ comes with Python 2.7 preinstalled by Apple. If you are running an earlier version of Mac OS X, download and install [Python 2.7.12+](https://www.python.org/downloads/mac-osx/).
61+
Mac OS X 10.8+ comes with Python 2.7 preinstalled by Apple. If you are running an earlier version of Mac OS X, download and install [Python versions 2.7.11+ or 3.6.5+](https://www.python.org/downloads/mac-osx/).
4062

4163
To install Pip, run `sudo easy_install pip` from your command-line.
4264

@@ -50,7 +72,7 @@ Download and install a compiler.
5072

5173
To install Mbed CLI, run `pip install mbed-cli` from your command-line.
5274

53-
You can ensure Mbed CLI installed correctly by running `mbed help`.
75+
You can ensure Mbed CLI installed correctly by running `mbed --version`.
5476

5577
##### 4. Setup environment
5678

@@ -72,12 +94,12 @@ ARM_PATH=<path to ARM bin\>
7294

7395
##### 1. Install Python and Pip
7496

75-
Download and install [Python 2.7.12+](https://www.python.org/downloads/source/) or run the following from your command-line:
97+
Download and install [Python versions 2.7.11+ or 3.6.5+](https://www.python.org/downloads/source/), or use your distrubution's package manager to install Python and Pip.
98+
99+
As an example, you can use the following in Ubuntu:
76100

77101
```console
78-
$ sudo apt-get install python2.7
79-
$ sudo apt-get install python-pip
80-
$ sudo apt-get update
102+
$ sudo apt-get install python2.7 python-pip
81103
```
82104

83105
##### 2. Install a compiler

0 commit comments

Comments
 (0)