Skip to content

Minor change on docs #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 4, 2018
Merged

Minor change on docs #3

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c55d9c
Minor change on docs
Nov 28, 2018
ae189fb
Minor fixes as suggested
Dec 3, 2018
aadc06c
Update README.md
Dec 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Running Mbed Crypto examples on Mbed OS
This repository contains a set of examples demonstrating the compilation and use
of Mbed Crypto on Mbed OS.
This repository contains a set of examples demonstrating the compilation and use of Mbed Crypto on Mbed OS.

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

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

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

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

## Program your board
1. Connect your Mbed device to the computer over USB.
1. Copy the binary file (`mbed-os-example-mbed-crypto.bin`) to the Mbed device.

## Run
The following are the steps required to run the example program:
* Connect the Mbed device to your computer over USB.
* Copy the binary file (`mbed-os-example-mbed-crypto.bin`) to the Mbed device.
* Connect to the Mbed Device using a serial client application of your choice.
* Press the reset button on the Mbed device to run the program.
1. Connect to the Mbed Device using a serial client application of your choice.
1. Press the reset button on the Mbed device to run the program.

The expected output from a successful execution of the example program should be as follows:
```
Expand All @@ -38,3 +37,7 @@ cipher encrypt/decrypt AES CBC PKCS7 multipart:
cipher encrypt/decrypt AES CTR multipart:
success!
```

## Troubleshooting
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.