Skip to content

Commit b5a4e60

Browse files
authored
Merge pull request #3 from ARMmbed/minor-doc-tweak
Minor change on docs
2 parents e8ee8c3 + aadc06c commit b5a4e60

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Running Mbed Crypto examples on Mbed OS
2-
This repository contains a set of examples demonstrating the compilation and use
3-
of Mbed Crypto on Mbed OS.
2+
This repository contains a set of examples demonstrating the compilation and use of Mbed Crypto on Mbed OS.
43

54
List of examples contained within this repository:
65
* Cipher encrypt/decrypt using an AES key in cipher block chain (CBC) mode with no padding using a single block.
@@ -10,24 +9,24 @@ List of examples contained within this repository:
109
## Prerequisites
1110
* Install <a href='https://github.com/ARMmbed/mbed-cli#installing-mbed-cli'>Mbed CLI</a>
1211

13-
## Deploy
14-
The following are the steps required for deployment:
15-
* Clone this repository: `git clone git@github.com:ARMmbed/mbed-os-example-mbed-crypto.git`
12+
## Import
13+
The following are the steps required to install the application:
14+
* Clone the repository and deploy the Mbed OS project: `mbed import https://github.com/ARMmbed/mbed-os-example-mbed-crypto`
1615
* Change your current directory: `cd mbed-os-example-mbed-crypto`
17-
* Fetch Mbed OS: `mbed deploy`
1816

1917
## Compile
2018
To compile the example program use `mbed compile` while specifying the target platform and the compiler.
2119
For example, in order to compile using the ARM GCC compiler and a K64F target platform use: `mbed compile -m K64F -t ARM`.
2220

2321
Once the compilation is completed successfully a binary file will be created: `./BUILD/K64F/GCC_ARM/mbed-os-example-mbed-crypto.bin`
2422

23+
## Program your board
24+
1. Connect your Mbed device to the computer over USB.
25+
1. Copy the binary file (`mbed-os-example-mbed-crypto.bin`) to the Mbed device.
26+
2527
## Run
26-
The following are the steps required to run the example program:
27-
* Connect the Mbed device to your computer over USB.
28-
* Copy the binary file (`mbed-os-example-mbed-crypto.bin`) to the Mbed device.
29-
* Connect to the Mbed Device using a serial client application of your choice.
30-
* Press the reset button on the Mbed device to run the program.
28+
1. Connect to the Mbed Device using a serial client application of your choice.
29+
1. Press the reset button on the Mbed device to run the program.
3130

3231
The expected output from a successful execution of the example program should be as follows:
3332
```
@@ -38,3 +37,7 @@ cipher encrypt/decrypt AES CBC PKCS7 multipart:
3837
cipher encrypt/decrypt AES CTR multipart:
3938
success!
4039
```
40+
41+
## Troubleshooting
42+
If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.
43+

0 commit comments

Comments
 (0)