cypress: update user documentation with disclaimer and additional instructions
This change adds Disclaimer section to Cypress related documentation and adds details about custom hardware configuration flow.
Signed-off-by: Roman Okhrimenko <roman.okhrimenko@cypress.com>
diff --git a/boot/cypress/README.md b/boot/cypress/README.md
index 66f9597..9dc7def 100644
--- a/boot/cypress/README.md
+++ b/boot/cypress/README.md
@@ -1,10 +1,19 @@
-### Port of MCUBoot library to be used with Cypress targets
+### Port of MCUBoot library for evaluation with Cypress PSoC 6 chips
-**Solution Description**
+### Disclaimer
-Given solution demonstrates operation of MCUBoot on Cypress' PSoC6 device.
+Given solution is included in `mcuboot` repository with purpose to demonstrate basic consepts and features of MCUBoot library on Cypress PSoC 6 device. Applications are created per mcuboot library maintainers requirements. Implemetation differs from conventional and recomended by Cypress Semiconductors development flow for PSoC 6 devices. These applications are not recomended as a starting point for development and should not be considered as supported examples for PSoC 6 devices.
-There are four applications implemented:
+Examples provided to use with **ModusToolbox® Software Environment** are a recommended reference point to start development of MCUBoot based bootloaders for PSoC 6 devices.
+
+Refer to **Cypress Semiconductors** [github](https://github.com/cypresssemiconductorco) page to find examples.
+
+1. MCUboot-Based Basic Bootloader [mtb-example-psoc6-mcuboot-basic](https://github.com/cypresssemiconductorco/mtb-example-psoc6-mcuboot-basic)
+2. MCUboot-Based Bootloader with Rollback to Factory App in External Flash [mtb-example-anycloud-mcuboot-rollback](https://github.com/cypresssemiconductorco/mtb-example-anycloud-mcuboot-rollback)
+
+### Solution Description
+
+There are two applications implemented:
* MCUBootApp - PSoC6 MCUBoot-based bootloading application;
* BlinkyApp - simple PSoC6 blinking LED application which is a target of BOOT/UPGRADE;
@@ -22,7 +31,7 @@
MCUBootApp checks image integrity with SHA256, image authenticity with EC256 digital signature verification and uses completely SW implementation of cryptographic functions based on mbedTLS Library.
-**Downloading Solution's Assets**
+### Downloading Solution's Assets
There is a set assets required:
@@ -43,7 +52,7 @@
-**Building Solution**
+### Building Solution
Root directory for build is **boot/cypress.**
@@ -51,11 +60,11 @@
Instructions on how to build and upload MCUBootApp bootloader application and sample user applocation are located in `Readme.md` files in corresponding folders.
-**Currently supported platforms:**
+Currently supported platforms:
* PSOC_062_2M - for MCUBoot, BlinkyApp;
-**Build environment troubleshooting:**
+### Build environment troubleshooting
Following CLI / IDE are supported for project build: