Skip to content

Commit db463f2

Browse files
committed
Spelling fixes and general readability improvements
1 parent 920db63 commit db463f2

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

TEST_APPS/readme.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,54 +2,55 @@
22

33
### Structure
44

5-
mbed-os has a folder called TEST_APPS that contains everything related to Icetea testing.
5+
Mbed OS has a folder called `TEST_APPS` that contains everything related to Icetea testing.
66
There are currently 3 folders:
77

8-
- device - contains all the different test applications you can flash to your board
9-
- icetea-plugins - contains plugins that are being used by some of the testcases, needed for the test execution
10-
- testcases - contains Icetea testcases written in Python
8+
- `device` - contains all the different test applications you can flash to your board
9+
- `icetea_plugins` - contains plugins that are being used by some of the testcases, needed for the test execution
10+
- `testcases` - contains Icetea testcases written in Python
1111

12-
The testcases depends on test applications
12+
The testcases depend on test applications.
1313

1414
### Preparing your work environment
1515

16-
#### Prerequisities
16+
#### Prerequisites
1717

18-
You need Icetea and mbed-cli that supports Icetea, installed.
18+
You need Icetea and version 1.8.0 or higher of Mbed CLI installed.
1919

2020
#### Selecting the network interface to use
2121

22-
Depending on a device, there might be a default network interface type defined in the mbed-os/targets/targets.json, which is used to locate a test-config file by default.
23-
If there is not, or you want to use a different interface than the default, you need to provide a relevant test-config -file to the mbed test with --test-config option.
24-
The test-config file contains the necessary information for the test application, there are some test-config files located under mbed-os/tools/test_configs.
25-
Devices which have their network drivers residing inside mbed-os can use generic test_configs like HeapBlockDeviceAndEthernetInterface.json and HeapBlockDeviceAndWifiInterface.json. Otherwise you need to use a device specific test-config.
22+
Depending on the device, there might be a default network interface type defined in `mbed-os/targets/targets.json`, which is used to locate a default test-config file.
23+
If default network interface type is not defined, or you want to use a different interface than the default, you need to provide a test-config file to the mbed test with `--test-config` option.
24+
25+
The test-config file contains the necessary information for the test application. There are some test-config files located under `mbed-os/tools/test_configs`.
26+
Devices which have their network drivers residing inside mbed-os can use generic test_configs like `HeapBlockDeviceAndEthernetInterface.json` and `HeapBlockDeviceAndWifiInterface.json`. Otherwise you need to use a device specific test-config.
2627

2728
### Running the tests
2829

29-
Now that the interface has been selected you can run the icetea tests from the mbed-os root on your command line by
30+
Now that the interface has been selected you can run the icetea tests from the mbed-os root on your command line by running the following command:
3031

31-
`>mbed test -m <target> -t <toolchain> --icetea`
32+
`mbed test -m <target> -t <toolchain> --icetea`
3233

33-
This command will compile the mbed-os, then compiles the test applications, creates a test suite and then starts running the tests.
34+
This command compiles the OS, compiles the test applications, creates a test suite and then starts running the tests.
3435

35-
If you want only to run some specific tests, you can use the -n -option. You can list multiple tests by separating them by comma (,).
36+
If you only want to run some specific tests, you can use the `-n` option. You can choose multiple tests by separating them with a comma (`,`):
3637

37-
`>mbed test -m <target> -t <toolchain> --icetea -n test1,test2`
38+
`mbed test -m <target> -t <toolchain> --icetea -n test1,test2`
3839

39-
#### Running the tests with specifig test-config
40+
#### Running the tests with a specific test-config
4041

41-
Some devices may offer multiple network interfaces to operate with. For example, UBLOX_EVK_ODIN_W2 offers ethernet and Wi-Fi capabilities.
42+
Some devices may offer multiple network interfaces to operate with. For example, `UBLOX_EVK_ODIN_W2` offers ethernet and Wi-Fi capabilities.
4243
The tests can be run for either one of those using already existing test-config -files.
4344

44-
To run the tests with Wi-Fi interface:
45-
`>mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndWifiInterface.json`
45+
To run the tests with the Wi-Fi interface:
46+
`mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndWifiInterface.json`
4647

47-
To run the tests with ethernet interface:
48-
`>mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndEthernetInterface.json`
48+
To run the tests with the ethernet interface:
49+
`mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndEthernetInterface.json`
4950

5051
#### Providing Wi-Fi access point information
5152

52-
If you are using Wi-Fi interface for running the tests, you need to provide also information about the used access point.
53+
If you are using the Wi-Fi interface for running the tests, you need to also provide information about the used access point.
5354
The information can be provided in the used test-config file.
5455

5556
Example of access point information:

0 commit comments

Comments
 (0)