Skip to content

Commit dce649c

Browse files
Amanda ButlerAri Parkkila
authored andcommitted
Copy edit README.md
Copy edit file for active voice and consistent capitalization.
1 parent e53b931 commit dce649c

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

features/cellular/README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Mbed Cellular Connectivity
1+
# Mbed cellular connectivity
22

33
This is the Github repo for Mbed cellular connectivity:
44

55
easy_cellular/
6-
EasyCellularConnection Simplified cellular usage based on CellularBase.h
7-
CellularConnectionUtil An utility class for cellular connection
6+
EasyCellularConnection Simplified cellular usage based on `CellularBase.h`
7+
CellularConnectionUtil A utility class for cellular connection
88

99
framework/
1010
API Application Programming Interface for cellular connectivity
@@ -13,19 +13,19 @@ This is the Github repo for Mbed cellular connectivity:
1313
mux MUX implementation based on 3GPP TS 27.010 specification
1414
targets Vendor specific cellular module adaptations
1515

16-
## Known Limitations
16+
## Known limitations
1717

18-
**Please note that as a first release framework is subject to change and may break code that uses it.**
18+
**Please note that as a first release framework, this content is subject to change and may break code that uses it.**
1919

20-
Only UDP is supported when using AT commands to control sockets in an IP stack built into the cellular modem. If TCP is required use PPP/LWIP stack.
20+
Only UDP is supported when using AT commands to control sockets in an IP stack built into the cellular modem. If TCP is required, use the PPP/LWIP stack.
2121

22-
## Supported Modules
22+
## Supported modules
2323

24-
Currently supported cellular modules can be found in the framework/targets/ folder, where also support for new cellular modules are added.
24+
You can find currently supported cellular modules in the `framework/targets/` folder, where we also add support for new cellular modules.
2525

26-
## Cellular Configuration
26+
## Cellular configuration
2727

28-
Cellular defaults can be changed in mbed_app.json configuration file:
28+
You can change cellular defaults in the `mbed_app.json` configuration file:
2929

3030
"config": {
3131
"cellular_plmn": {
@@ -42,9 +42,9 @@ Cellular defaults can be changed in mbed_app.json configuration file:
4242
}
4343
}
4444

45-
## Debug Traces
45+
## Debug traces
4646

47-
Debug tracing level can be defined in mbed_app.json configuration file:
47+
You can define the debug tracing level in the `mbed_app.json` configuration file:
4848

4949
"target_overrides": {
5050
"*": {
@@ -65,12 +65,10 @@ Debug tracing level can be defined in mbed_app.json configuration file:
6565

6666
## Unit tests
6767

68-
UNITTESTS folder contains unittests for Cellular specific classes. Unittests are based on stubbing method and some of the platform headers has been hacked under target_h/ folder to get things working.
69-
70-
You can run those tests locally by running ./run_tests script under UNITTESTS/ folder.
71-
72-
you will need at least following applications: cpputest, gcov and lcov (genhtml) for running the tests.
73-
After run_tests script has been run you can find test results under UNITTESTS/results folder and line & function coverages under UNITTESTS/coverages folder
68+
The `UNITTESTS` folder contains unit tests for cellular specific classes. Unit tests are based on the stubbing method.
7469

70+
You can run those tests locally by running `./run_tests` script under the `UNITTESTS/` folder.
7571

72+
You need the following applications: `cpputest`, `gcov` and `lcov` (genhtml) for running the tests.
7673

74+
After you have run the `run_tests` script, you can find test results under `UNITTESTS/results` folder and line and function coverages under the `UNITTESTS/coverages` folder.

0 commit comments

Comments
 (0)