Skip to content

Commit 8e3af6d

Browse files
committed
Incremental documentation changes
1 parent 83911e0 commit 8e3af6d

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

100644100755
Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,27 +46,27 @@ This document covers the installation and usage of *mbed CLI*.
4646

4747
<span class="tips">**Note:** The directories of Git and Mercurial executables (`git` and `hg`) need to be in your system's PATH.</span>
4848

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
5151
* Toolchains: Keil uVision, DS-5, IAR Workbench
5252

5353
### Installing mbed CLI
5454

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:
5656

5757
``$ pip install mbed-cli``
5858

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):
6060

61-
``$ git clone https://github.com/ARMmbed/mbed-cli``
61+
``$ git clone https://github.com/ARMmbed/mbed-cli``
6262

63-
Once cloned you can install *mbed CLI* as a python package:
63+
Once cloned you can install *mbed CLI* as a python package:
6464

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)
6666

6767
<span class="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>
6868

69-
### Uninstalling mbed-cli
69+
### Uninstalling mbed CLI
7070

7171
To uninstall *mbed CLI*, simply run:
7272

@@ -88,6 +88,7 @@ Various *mbed CLI* features require a program root, which whenever possible shou
8888
<span class="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>
8989

9090
### mbed CLI help
91+
9192
To list all *mbed CLI* commands use `mbed --help`. A detailed command-specific help is available via `mbed <command> --help`.
9293

9394
### Creating and importing programs
@@ -505,6 +506,9 @@ A ``.uvproj`` file is created in the projectfiles/uvision folder. You can open t
505506

506507
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:
507508

509+
#### Listing and compiling tests
510+
511+
508512
```
509513
$ mbed test --list-compile
510514
Test Case:
@@ -560,6 +564,7 @@ Compiled test binaries are created in ```.build/<TARGET>/<TOOLCHAIN>/TestCase1.b
560564

561565
<span class="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>
562566

567+
#### Listing and compiling tests
563568

564569
## Known limitations
565570

0 commit comments

Comments
 (0)