Skip to content

Commit e751b5e

Browse files
author
Amanda Butler
authored
Merge pull request #290 from ARMmbed/mbed-cli-docs-tweaks
Reorder content on Windows installer for Mbed CLI
2 parents d078816 + e895090 commit e751b5e

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

docs/tools/offline/cli-setup.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
You can install Mbed CLI on Windows, Linux and Mac OS X.
55

6+
<span class="tips">If you're working on Windows, we recommend you use the [Windows installer for Mbed CLI](#windows-installer-for-mbed-cli). For Linux and Mac OS X, refer to the section [Installing Mbed CLI standalone stable version](#installing-mbed-cli-standalone-stable-version)</span>
7+
68
### Requirements
79

810
- **Python:** Mbed CLI is a Python script, so you'll need Python to use it:
@@ -57,11 +59,11 @@ $ python setup.py install
5759
5860
On Linux or Mac, you may need to run with `sudo`.
5961
60-
#### Mbed CLI for Windows installer
62+
#### Windows installer for Mbed CLI
6163
6264
Mbed CLI for Windows installs <a href="https://github.com/ARMmbed/mbed-cli" target="_blank">Mbed CLI</a> with all requirements on Windows 7 and newer (both the 32- and 64-bit versions).
6365
64-
Mbed CLI for Windows installs the following components:
66+
The Windows installer for Mbed CLI for includes the following components:
6567
6668
- **Python** - Mbed CLI is a Python script, so you need Python to use it. Installer installs <a href="https://www.python.org/downloads/release/python-2713/" target="_blank">version 2.7.13 of Python</a>. It is not compatible with Python 3.
6769
- **Mbed CLI version 1.2.0** - <a href="https://github.com/ARMmbed/mbed-cli" target="_blank">Mbed CLI</a>.
@@ -71,7 +73,7 @@ Mbed CLI for Windows installs the following components:
7173
- **GNU Arm Embedded Toolchain** - <a href="https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads" target="_blank">GNU Embedded Toolchain for Arm</a>.
7274
- **Mbed Windows serial port driver** - <a href="/docs/v5.6/tutorials/windows-serial-driver.html" target="_blank">serial port driver</a>.
7375
74-
##### Install Mbed CLI for Windows installer
76+
##### Install Windows installer for Mbed CLI
7577
7678
1. Download the latest executable from <a href="https://mbed-media.mbed.com/filer_public/c8/79/c8792672-7b80-4c48-ac51-d08691c1515a/mbed_installer_v042.exe" target="_blank">`mbed-windows-installer v0.42`</a>.
7779
2. Run `mbed_installer_v042.exe`.
@@ -106,6 +108,32 @@ $ mbed --help
106108
107109
4. Check <a href="https://github.com/ARMmbed/mbed-cli" target="_blank">Mbed CLI</a> for more examples.
108110
111+
### Installing Mbed CLI standalone stable version
112+
113+
Find the latest stable version of Mbed CLI through pip by running:
114+
115+
```
116+
$ pip install mbed-cli
117+
```
118+
119+
On Linux or Mac, you may need to run with `sudo`.
120+
121+
#### Optional: installing the development version
122+
123+
To work with the development version and contribute to Mbed CLI, clone the development repository [https://github.com/ARMmbed/mbed-cli](https://github.com/ARMmbed/mbed-cli):
124+
125+
```
126+
$ git clone https://github.com/ARMmbed/mbed-cli
127+
```
128+
129+
Once you have cloned the repository, you can install Mbed CLI as a Python package:
130+
131+
```
132+
$ python setup.py install
133+
```
134+
135+
On Linux or Mac, you may need to run with `sudo`.
136+
109137
### Configuring Mbed CLI
110138
111139
There are some configuration that you must set before you can work with Mbed CLI.

0 commit comments

Comments
 (0)