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
@@ -46,27 +46,27 @@ This document covers the installation and usage of *mbed CLI*.
46
46
47
47
<spanclass="tips">**Note:** The directories of Git and Mercurial executables (`git` and `hg`) need to be in your system's PATH.</span>
48
48
49
-
***A command-line compiler or IDE Toolchain** - *mbed CLI* invokes the [mbed OS](https://github.com/ARMmbed/mbed-os) tools for various features - compiling, testing, exporting to industry standard toolchains. To compile your code, you would need either of these:
50
-
* Compilers: GCC ARM, ARMCC, IAR
49
+
***Command-line compiler or IDE Toolchain** - *mbed CLI* invokes the [mbed OS](https://github.com/ARMmbed/mbed-os) tools for various features - compiling, testing, exporting to industry standard toolchains. To compile your code, you would need either of these:
50
+
* Compilers: GCC ARM, ARMCC 5, IAR
51
51
* Toolchains: Keil uVision, DS-5, IAR Workbench
52
52
53
53
### Installing mbed CLI
54
54
55
-
1.You can get the latest stable version of *mbed CLI* via PyPI by running:
55
+
You can get the latest stable version of *mbed CLI* via PyPI by running:
56
56
57
57
``$ pip install mbed-cli``
58
58
59
-
1.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):
59
+
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:
63
+
Once cloned you can install *mbed CLI* as a python package:
64
64
65
-
``$ python setup.py install`` (on Linux/Mac, you may need to run with ``sudo`` as well)
65
+
``$ python setup.py install`` (on Linux/Mac, you may need to run with ``sudo`` as well)
66
66
67
67
<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>
68
68
69
-
### Uninstalling mbed-cli
69
+
### Uninstalling mbed CLI
70
70
71
71
To uninstall *mbed CLI*, simply run:
72
72
@@ -88,6 +88,7 @@ Various *mbed CLI* features require a program root, which whenever possible shou
88
88
<spanclass="warnings">**Warning**: *mbed CLI* stores information about libraries and dependencies in reference files that use the `.lib` extension (e.g. `lib_name.lib`). While these files are human-readable, we *strongly* advise that you don't edit these manually and let *mbed CLI* manage them instead.</span>
89
89
90
90
### mbed CLI help
91
+
91
92
To list all *mbed CLI* commands use `mbed --help`. A detailed command-specific help is available via `mbed <command> --help`.
92
93
93
94
### Creating and importing programs
@@ -505,6 +506,9 @@ A ``.uvproj`` file is created in the projectfiles/uvision folder. You can open t
505
506
506
507
mbed OS comes with a comprehensive set of test tools (see blah.blah.com), and you can use *mbed CLI* to manage and execute tests for you. Use `mbed test --list-compile` to list the tests available:
507
508
509
+
#### Listing and compiling tests
510
+
511
+
508
512
```
509
513
$ mbed test --list-compile
510
514
Test Case:
@@ -560,6 +564,7 @@ Compiled test binaries are created in ```.build/<TARGET>/<TOOLCHAIN>/TestCase1.b
560
564
561
565
<spanclass="notes">**Note:** This feature does not work in application modules that contain ```main()```. This issue is being worked on in parallel. However, currently we don't have any module with ```main()``` and ```TESTS``` together. Hence it does not break any existing module.</span>
0 commit comments