You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,23 +58,27 @@ This document covers the installation and usage of *mbed CLI*.
58
58
59
59
You can get the latest stable version of *mbed CLI* via PyPI by running:
60
60
61
-
``$ pip install mbed-cli``
61
+
```
62
+
$ pip install mbed-cli
63
+
```
62
64
63
65
Alternatively you get the development version of *mbed CLI* by cloning the development repository [https://github.com/ARMmbed/mbed-cli](https://github.com/ARMmbed/mbed-cli):
Once cloned you can install *mbed CLI* as a python package:
68
70
69
-
``$ python setup.py install`` (on Linux/Mac, you may need to run with ``sudo`` as well)
71
+
`$ python setup.py install` (on Linux/Mac, you may need to run with `sudo` as well)
70
72
71
73
<spanclass="tips">**Note:***mbed CLI* is compatible with [Virtual Python Environment (virtualenv)](https://pypi.python.org/pypi/virtualenv). You can read more about isolated Python virtual environments [here](http://docs.python-guide.org/en/latest/).</span>
72
74
73
75
### Uninstalling mbed CLI
74
76
75
77
To uninstall *mbed CLI*, simply run:
76
78
77
-
``pip uninstall mbed-cli``
79
+
```
80
+
pip uninstall mbed-cli
81
+
```
78
82
79
83
## Using mbed CLI
80
84
@@ -382,8 +386,8 @@ Through the workflow explained above, mbed CLI will maintain association to the
382
386
383
387
After importing a program or creating a new one, you need to tell *mbed CLI* where to find the toolchains that you want to use for compiling your source tree. *mbed CLI* gets this information from a file named `mbed_settings.py`, which is automatically created at the top of your cloned repository (if it doesn't already exist). As a rule, since `mbed_settings.py` contains local settings (possibly relevant only to a single OS on a single machine), it should not be versioned. In this file:
384
388
385
-
* If you want to use the [ARM Compiler toolchain](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler-5/downloads), set ``ARM_PATH`` to the *base* directory of your ARMCC installation (example: c:\software\armcc5.06). The recommended version of the ARMCC toolchain is 5.06 (5.05 will very likely work too).
386
-
* If you want to use the [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), set ``GCC_ARM_PATH`` to the *binary* directory of your GCC ARM installation (example: c:\software\GNUToolsARMEmbedded\4.82013q4\bin). Use versions 4.8 or 4.9 of GCC ARM Embedded, but version 5.0 or any version above might be incompatible with the tools.
389
+
* If you want to use the [ARM Compiler toolchain](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler-5/downloads), set `ARM_PATH` to the *base* directory of your ARMCC installation (example: c:\software\armcc5.06). The recommended version of the ARMCC toolchain is 5.06 (5.05 will very likely work too).
390
+
* If you want to use the [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), set `GCC_ARM_PATH` to the *binary* directory of your GCC ARM installation (example: c:\software\GNUToolsARMEmbedded\4.82013q4\bin). Use versions 4.8 or 4.9 of GCC ARM Embedded, but version 5.0 or any version above might be incompatible with the tools.
387
391
388
392
#### Compiling your program
389
393
@@ -511,7 +515,7 @@ ___Macros___
511
515
512
516
You can specify macros in your command line using the -D option. For example:
Using ``mbed target <target>`` and ``mbed toolchain <toolchain>`` you can set the default target and toolchain for your program, meaning you won't have to specify these every time you compile or generate IDE project files.
533
+
Using `mbed target <target>` and `mbed toolchain <toolchain>` you can set the default target and toolchain for your program, meaning you won't have to specify these every time you compile or generate IDE project files.
530
534
531
535
### Exporting to desktop IDEs
532
536
@@ -538,7 +542,7 @@ For example, to export to uVision run:
538
542
$ mbed export -i uvision -m K64F
539
543
```
540
544
541
-
A ``.uvproj`` file is created in the projectfiles/uvision folder. You can open the project file with uVision.
545
+
A `.uvproj` file is created in the projectfiles/uvision folder. You can open the project file with uVision.
542
546
543
547
### Testing
544
548
@@ -659,7 +663,7 @@ Test code exists in the following directory structure:
659
663
660
664
```
661
665
mbed-os-program
662
-
|- main.cpp # Optional main.cpp with ```main()``` if it is an application module.
666
+
|- main.cpp # Optional main.cpp with main() if it is an application module.
0 commit comments