Skip to content

Commit 309f720

Browse files
Updating / Simplifying instructions based on feedback
1 parent b5dae91 commit 309f720

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The CI Test Shield has several uses.
1515
## What is tested?
1616
Current API's that are tested by the CI Test shield are as follows
1717

18-
1. `DigitalIO`, `Serial`, `InterruptIn`, `PwmOut` - tested by Loopback on pins D0-9
18+
1. `DigitalIO`, `InterruptIn`, `PwmOut` - tested by Loopback on pins D0-9
1919
2. `AnalogIO` - tested by resistor star network.
2020
3. `I2C` - tested with temperature sensor and EEPROM memory.
2121
4. `SPI` - tested with SD Card.
@@ -42,14 +42,14 @@ To run the tests associated with the ci-test-shield follow these steps:
4242

4343
#### Usage
4444

45-
0. Navigate to the repo on your command line. `cd ci-test-shield`
46-
1. Set your board using the `mbed config target xxx`, where xxx is the board name [protip: use `mbed target --supported` for list of supported boards].
47-
3. Set your toolchain using the `mbed config toolchain xxx`, where xxx is the toolchain. (`GCC_ARM`, `IAR`, `UVISION`...etc, use `mbed toolchain --supported` for a full list)
48-
4. Grab dependencies by running the `mbed update` command inside the top level of this repo. This will ensure you have the latest version of the mbed-os library. Alternatively you can swap out the mbed-os library for your version that you are testing.
49-
5. Run the tests with the test shield plugged into your board. The command will look like `mbed test -n tests-* --app-config .\mbed_app.json` to run all the CI Test Shield tests.
45+
0. `cd ci-test-shield`- Navigate to the repo on your command line.
46+
1. `mbed target auto` - Automatically detect board plugged into computer and set it as the target
47+
3. `mbed toolchain GCC_ARM` - Select compiler. You can also use IAR, UVISION, or any other toolchain listed in `mbed toolchain --supported`
48+
4. `mbed update` - Update libraries to latest version
49+
5. `mbed test -n tests-* --app-config .\mbed_app.json` - Run CI Test Shield tests.
5050

5151
## Customization
52-
All pin mappings are done in the `mbed_app.json` file. If you need to remap anything this is the palce to do it.
52+
All pin mappings are done in the `mbed_app.json` file. If you need to remap or override you can do so here. Please note that all pin mappings will be pre-pended with `MBED_APP_CONF_`.
5353

5454
#### Different Pins
5555
If your board has peripherals on pins that differ from the Arduino R3 Header layout you will need to manually fly wire them into the appropriate header and adjust the `mbed_app.json` file.

0 commit comments

Comments
 (0)