Skip to content

Commit 49cf9da

Browse files
author
Amanda Butler
authored
Edit REAMDE.md
Make minor edits
1 parent 9785fc7 commit 49cf9da

File tree

1 file changed

+39
-41
lines changed

1 file changed

+39
-41
lines changed

tools/README.md

Lines changed: 39 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,43 @@
1-
# Mbed OS Build Tools
1+
# Mbed OS build tools
22

3-
This directory contains the python tools used for building Mbed OS and
4-
Mbed 2.
3+
This directory contains the Python tools used for building Mbed OS and Mbed 2.
54

65
Quick navigation:
76

8-
| file/directory | Purpose/function |
9-
|-----------------------|------------------------------------------------|
10-
| `build.py` | implementation of `mbed compile --library` |
11-
| `build_api.py` | full-project build operations |
12-
| `build_release.py` | CLI for making an mbed 2 release |
13-
| `config` | implementation of Config System |
14-
| `debug_tools` | Crash log parsing |
15-
| `default_settings.py` | Default version of project local `settings.py` |
16-
| `detect_targets.py` | implementation of `mbed detect` |
17-
| `device_management.py`| implementation of `mbed device-management` |
18-
| `export` | Export plugins and API for woking with them |
19-
| `flash_algo` | CMSIS flash algorithm parser |
20-
| `get_config.py` | implementation of `mbed compile --config` |
21-
| `host_tests` | location of pre-htrun host tests |
22-
| `importer` | code importer for use with CMSIS, TFM/PSA etc. |
23-
| `libraries.py` | constants for building mbed 2 libraries |
24-
| `make.py` | implementation of `mbed compile` |
25-
| `memap.py` | map file parser and sumary generator |
26-
| `notifier` | API for seting compile status to a frontend |
27-
| `options.py` | Default option parser and option utilities |
28-
| `paths.py` | constants for many paths used |
29-
| `profiles` | location of the default build profiles |
30-
| `project.py` | implementation of `mbed export` |
31-
| `psa` | PSA |
32-
| `regions.py` | merging from managed bootloader mode |
33-
| `resources` | scans directories for files used in a project |
34-
| `run_icetea.py` | implementation of `mbed test --icetea` |
35-
| `settings.py` | project specific settings from env vars |
36-
| `singletest.py` | location of pre-greentea greentea |
37-
| `targets` | target description reader and post-build steps |
38-
| `test` | unit tests for tools |
39-
| `test_api.py` | part of pre-greentea greentea |
40-
| `test_configs` | configuration files used by `mbed test` |
41-
| `test_exporters.py` | part of pre-greentea greentea |
42-
| `tests.py` | implementation of `mbed test --greentea` |
43-
| `toolchains` | API for calling the selected compiler |
44-
| `utils.py` | General purpose utilities like file moving |
45-
7+
| File/directory | Purpose/function |
8+
|-----------------------|-----------------------------------------------------|
9+
| `build.py` | Implementation of `mbed compile --library` |
10+
| `build_api.py` | Full-project build operations |
11+
| `build_release.py` | CLI for making an Mbed 2 release |
12+
| `config` | Implementation of the configuration system |
13+
| `debug_tools` | Crash log parsing |
14+
| `default_settings.py` | Default version of project local `settings.py` |
15+
| `detect_targets.py` | Implementation of `mbed detect` |
16+
| `device_management.py`| Implementation of `mbed device-management` |
17+
| `export` | Export plugins and API for woking with them |
18+
| `flash_algo` | CMSIS flash algorithm parser |
19+
| `get_config.py` | Implementation of `mbed compile --config` |
20+
| `host_tests` | Location of pre-htrun host tests |
21+
| `importer` | Code importer for use with CMSIS, TFM/PSA and so on |
22+
| `libraries.py` | Constants for building Mbed 2 libraries |
23+
| `make.py` | Implementation of `mbed compile` |
24+
| `memap.py` | Map file parser and summary generator |
25+
| `notifier` | API for seting compile status to a front end |
26+
| `options.py` | Default option parser and option utilities |
27+
| `paths.py` | Constants for many paths used |
28+
| `profiles` | Location of the default build profiles |
29+
| `project.py` | Implementation of `mbed export` |
30+
| `psa` | PSA |
31+
| `regions.py` | Merging from managed bootloader mode |
32+
| `resources` | Scans directories for files used in a project |
33+
| `run_icetea.py` | Implementation of `mbed test --icetea` |
34+
| `settings.py` | Project specific settings from env vars |
35+
| `singletest.py` | Location of pre-greentea greentea |
36+
| `targets` | Target description reader and postbuild steps |
37+
| `test` | Unit tests for tools |
38+
| `test_api.py` | Part of pre-greentea greentea |
39+
| `test_configs` | Configuration files used by `mbed test` |
40+
| `test_exporters.py` | Part of pre-greentea greentea |
41+
| `tests.py` | Implementation of `mbed test --greentea` |
42+
| `toolchains` | API for calling the selected compiler |
43+
| `utils.py` | General purpose utilities, such as file moving |

0 commit comments

Comments
 (0)