Skip to content

Commit 7ffe985

Browse files
committed
Incremental documentation changes
1 parent 59d5979 commit 7ffe985

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ This document covers the installation and usage of *mbed CLI*.
77
## Table of Contents
88
1. [Requirements](#requirements)
99
1. [Installing and uninstalling](#installing-mbed-cli)
10-
1. [Working context and command help](#working-context-and-command-help)
10+
1. [Working context and command help](#working-context)
1111
1. [Creating and importing programs](#creating-and-importing-programs)
12-
1. [Importing an existing program](#importing-an-existing-program)
13-
2. [Creating a new program](#creating-a-new-program)
12+
1. [Creating a new program](#creating-a-new-program)
13+
2. [Importing an existing program](#importing-an-existing-program)
1414
1. [Adding and removing libraries](#adding-and-removing-libraries)
1515
1. [Adding a library](#adding-a-library)
1616
2. [Removing a library](#removing-a-library)
@@ -26,10 +26,10 @@ This document covers the installation and usage of *mbed CLI*.
2626
2. [Compiling your program](#compiling-your-program)
2727
3. [Compiling static libraries](#compiling-static-libraries)
2828
4. [Compile configuration system](#compile-configuration-system)
29-
5. [Customizing the build](#customizing-the-build)
29+
5. [Compile-time customizations](#compile-time-customizations)
3030
6. [Automating toolchain and target selection](#automating-toolchain-and-target-selection)
31-
1. [Testing](#Testing)
3231
1. [Exporting to desktop IDEs](#exporting-to-desktop-ides)
32+
1. [Testing](#Testing)
3333
1. [Known limitations](#known-limitations)
3434

3535
## Installation
@@ -466,7 +466,7 @@ $ mbed compile --config -t GCC_ARM -m K64F --prefix target
466466
$ mbed compile --config -t GCC_ARM -m K64F --prefix target --prefix app
467467
```
468468

469-
#### Other compile customizations
469+
#### Compile-time customizations
470470

471471
___Macros___
472472

@@ -485,8 +485,23 @@ $ mbed compile -t GCC_ARM -m K64F -o debug-info
485485
<span class="tips">**Tip:** If you have files that you want to compile only in release mode, put them in a directory called `TARGET_RELEASE` at any level of your tree. If you have files that you want to compile only in debug mode, put them in a directory called `TARGET_DEBUG` at any level of your tree (then use `-o debug-info` as explained above).
486486
</span>
487487

488+
#### Automating toolchain and target selection
489+
490+
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.
491+
492+
### Exporting to desktop IDEs
493+
494+
If you need to debug your code, a good way to do that is to export your source tree to an IDE project file, so that you can use the IDE's debugging facilities. Currently *mbed CLI* supports exporting to Keil uVision, DS-5, IAR Workbench, Simplicity Studio and other IDEs.
495+
496+
For example, to export to uVision run:
497+
498+
```
499+
$ mbed export -i uvision -m K64F
500+
```
501+
502+
A ``.uvproj`` file is created in the projectfiles/uvision folder. You can open the project file with uVision.
488503

489-
#### Compiling tests
504+
### Testing
490505

491506
Use `mbed test --list-compile` to list the tests available:
492507

@@ -545,21 +560,6 @@ Compiled test binaries are created in ```.build/<TARGET>/<TOOLCHAIN>/TestCase1.b
545560

546561
<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>
547562

548-
#### Automating toolchain and target selection
549-
550-
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.
551-
552-
### Exporting to desktop IDEs
553-
554-
If you need to debug your code, a good way to do that is to export your source tree to an IDE project file, so that you can use the IDE's debugging facilities. Currently *mbed CLI* supports exporting to Keil uVision, DS-5, IAR Workbench, Simplicity Studio and other IDEs.
555-
556-
For example, to export to uVision run:
557-
558-
```
559-
$ mbed export -i uvision -m K64F
560-
```
561-
562-
A ``.uvproj`` file is created in the projectfiles/uvision folder. You can open the project file with uVision.
563563

564564
## Known limitations
565565

0 commit comments

Comments
 (0)