docs: Documentation improvements

* Move supported toolchain information from application docs to README.md to avoid duplicatiing it on all supported examples. * Move supported platforms description from docs/prerequisites.md to README.md to list and describe the supported platforms in one place. * Add supported versions information to supported targets. Signed-off-by: Devaraj Ranganna <[email protected]>
FreeRTOS · Feb 27, 2024 · e8b3c53 · e8b3c53
1 parent 5939246
commit e8b3c53
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -19,9 +19,27 @@ porting of this integration across platforms easy.
 
 ## Supported Targets
 
-* [Corstone-300](https://developer.arm.com/Processors/Corstone-300)
+Arm Corstone-3xx targets includes an example subsystem based on the Cortex-M
+CPU and Ethos NPU, alongside a range of other components in a scalable and
+flexible reference package. This enables designers to build secure,
+AI-capable SoCs faster.
+
 * [Corstone-310](https://developer.arm.com/Processors/Corstone-310)
+  * Arm Cortex-M85 CPU and Ethos-U55 NPU
+  * Supported versions: 11.24.13 and above
+* [Corstone-300](https://developer.arm.com/Processors/Corstone-300)
+  * Arm Cortex-M55 CPU and Ethos-U55 NPU
+  * Supported versions: 11.24.13 and above
+
+## Supported Toolchains
+
+* Arm Compiler for Embedded (armclang)
+* Arm GNU Toolchain (arm-none-eabi-gcc)
 
+> Note:
+  The build script `./tools/scripts/build.sh` assumes
+  `Arm Compiler for Embedded (armclang)` by default, append the extra option
+  `--toolchain GNU` to build using Arm GNU Toolchain.
 
 ## Directory structure
 

diff --git a/docs/aws_iot_example.md b/docs/aws_iot_example.md
@@ -31,11 +31,6 @@ Or, run the command below to perform a clean build:
 ./tools/scripts/build.sh aws-iot-example -c
 ```
 
-This will build the example with the Arm Compiler (armclang) by default. If you
-would like to build it with the Arm GNU Toolchain (arm-none-eabi-gcc)
-[installed by yourself](./development_environment.md), append the extra option
-`--toolchain GNU` to the build command above.
-
 ## Provisioning the device credentials into Protected Storage
 
 During the build process a ```provisioning_data.bin``` is built into the ```build/applications/aws_iot_example/provisioning_data``` directory.

diff --git a/docs/blinky.md b/docs/blinky.md
@@ -26,11 +26,6 @@ Run the command below to perform a clean build:
 ./tools/scripts/build.sh blinky -c
 ```
 
-This will build the example with the Arm Compiler (armclang) by default. If you
-would like to build it with the Arm GNU Toolchain (arm-none-eabi-gcc)
-[installed by yourself](./development_environment.md), append the extra option
-`--toolchain GNU` to the build command above.
-
 ## Running the application
 
 To run the blinky example, run the following command:

diff --git a/docs/keyword_detection.md b/docs/keyword_detection.md
@@ -59,11 +59,6 @@ Or, run the command below to perform a clean build:
 ./tools/scripts/build.sh keyword-detection --certificate_path <certificate pem's path> --private_key_path <private key pem's path> --target <corstone300/corstone310> --inference <ETHOS/SOFTWARE> --audio <ROM/VSI> -c
 ```
 
-This will build the example with the Arm Compiler (armclang) by default. If you
-would like to build it with the Arm GNU Toolchain (arm-none-eabi-gcc)
-[installed by yourself](./development_environment.md), append the extra option
-`--toolchain GNU` to the build command above.
-
 
 ## Provisioning the device credentials into Protected Storage
 During the build process a ```provisioning_data.bin``` is built into the ```build/applications/keyword_detection/provisioning_data``` directory.

diff --git a/docs/prerequisites.md b/docs/prerequisites.md
@@ -1,16 +1,6 @@
 # Prerequisites
 
-## Setting up the platforms
-
-This reference integration supports [Arm ecosystem FVPs](https://developer.arm.com/downloads/-/arm-ecosystem-fvps).
-
-The Corstone-310 model is a reference subsystem for a secure SSE-310 SoC
-aligned with the Arm MPS3 development platform. It is based on a Cortex®-M85
-processor and an Ethos-U55 neural network processor and the DMA-350
-Direct Memory Access controller. Follow the [link](https://developer.arm.com/downloads/-/arm-ecosystem-fvps)
-for more information.
-
-### Setting up Arm ecosystem FVPs
+## Setting up Arm ecosystem FVPs
 
 * Download the Corstone-310 FVP from [here](https://developer.arm.com/downloads/-/arm-ecosystem-fvps)
 * Run the following commands to install the Corstone-310 FVP and add FVP path

diff --git a/docs/running_aws_iot_core_device_advisor_tests.md b/docs/running_aws_iot_core_device_advisor_tests.md
@@ -89,11 +89,6 @@ Or, run the command below to perform a clean build:
 ./tools/scripts/build.sh ${APPLICATION_NAME} -c
 ```
 
-This will build the example with the Arm Compiler (armclang) by default. If you
-would like to build it with the Arm GNU Toolchain (arm-none-eabi-gcc)
-[installed by yourself](./development_environment.md), append the extra option
-`--toolchain GNU` to the build command above.
-
 ## Running the application
 
 We need to start the device advisor tests before running the application. If

diff --git a/docs/speech_recognition.md b/docs/speech_recognition.md
@@ -37,12 +37,6 @@ Or, run the command below to perform a clean build:
 ./tools/scripts/build.sh speech-recognition --certificate_path <certificate pem's path> --private_key_path <private key pem's path> --target <corstone300/corstone310> --inference <ETHOS/SOFTWARE> --audio <ROM/VSI> -c
 ```
 
-This will build the example with the Arm Compiler (armclang) by default. If you
-would like to build it with the Arm GNU Toolchain (arm-none-eabi-gcc)
-[installed by yourself](./development_environment.md), append the extra option
-`--toolchain GNU` to the build command above.
-
-
 ## Provisioning the device credentials into Protected Storage
 During the build process a ```provisioning_data.bin``` is built into the ```build/applications/speech_recognition/provisioning_data``` directory.
 This binary contains the device credentials (private key and certificate).