Verified Commit 631b4b5a authored by Vincent Coubard's avatar Vincent Coubard
Browse files

doc: Improve README



- Correct speech README title
- Fix typo
- Clarify keyword title
- Fix formatting issue

Signed-off-by: Vincent Coubard's avatarVincent Coubard <vincent.coubard@arm.com>
parent 2708fc61
......@@ -174,8 +174,8 @@ If you do not know your instance value, refer to the **AWS-Web-Console** instruc
# Build and execute the application
To update the application, a set of scripts is included to setup the environment,
build applications, run them and test them. These scripts must be executed in the AVH AMI.
A set of scripts is included to setup the environment, build applications, run them and test them.
These scripts must be executed in the AVH AMI.
## Connect
......@@ -473,7 +473,7 @@ This is done through setting defines in the same `bsp/default_credentials/iothub
`IOTHUB_DPS_ENDPOINT`, `IOTHUB_DPS_ID_SCOPE`, `IOTHUB_DPS_REGISTRATION_ID`, `IOTHUB_DPS_KEY` must all be set.
To obtain the values follow [Azure documentation](https://docs.microsoft.com/en-us/azure/iot-dps/quick-setup-auto-provision).
## Build the application to connect to your Azure IoT Hub
## Build the application to connect to your Azure IoT Hub
The application selects a cloud client (Aws or Azure) at build time. This is achieved by adding the flag `-e <AZURE|AWS>` to the build command line.
To build a version of keyword connecting to the Azure cloud on Corstone-300 and using FreeRTOS, use the following command line:
......@@ -491,7 +491,7 @@ To monitor activity (connection, disconnection, ...) follow the [reference instr
# Terminate Arm Virtual Hardware Instance
When you are done using the AMI instance at the end of the day, you need to make sure you shut it down properly or you may be charged for usage you did not actually use. There are 2 ways to do this action (pick one):
When you are done using the AMI instance at the end of the day, you need to make sure you shut it down properly or you may be charged for usage you did not actually use. There are two ways to do this action (pick one):
## Stopping the instance in EC2
1. Go to [EC2](https://console.aws.amazon.com/ec2/v2/) in the AWS Web Console.
......
# KWS Example
# Keyword Spotting Example
The Keyword Spotting application demonstrates Machine Learning running in a [TrustedFirmware-M](https://www.trustedfirmware.org/projects/tf-m/) controlled secure/non-secure partition configuration utilizing the [Ethos-U55](https://www.arm.com/products/silicon-ip-cpu/ethos/ethos-u55) microNPU on the following Arm platforms:
* Corstone-300
......
# KWS Example
# Speech Recognition Example
The Speech recognition application demonstrates Machine Learning running in a [TrustedFirmware-M](https://www.trustedfirmware.org/projects/tf-m/) controlled secure/non-secure partition configuration utilizing the [Ethos-U55](https://www.arm.com/products/silicon-ip-cpu/ethos/ethos-u55) microNPU on the following Arm platforms:
* Corstone-300
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment