doc: Updated index.md and readme.md
Updated index.md and readme.md:
- Removed outdated info
- Added info about newly added ports
- Fixed a few style issues.
- Rephrased a few sections.
Signed-off-by: Francesco Domenico Servidio <francesco.servidio@nordicsemi.no>
diff --git a/README.md b/README.md
index 53a0397..5274b6c 100644
--- a/README.md
+++ b/README.md
@@ -18,60 +18,65 @@
This is MCUboot version 1.8.0
-MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to
-define a common infrastructure for the bootloader, system flash layout on
-microcontroller systems, and to provide a secure bootloader that enables
-simple software upgrades.
+MCUboot is a secure bootloader for 32-bits microcontrollers. It defines a
+common infrastructure for the bootloader and the system flash layout on
+microcontroller systems, and provides a secure bootloader that enables easy
+software upgrade.
-MCUboot is operating system and hardware independent and relies on
-hardware porting layers from the operating. Currently, MCUboot works
-with both the Apache Mynewt and Zephyr operating systems, but more
-ports are planned in the future. RIOT is currently supported as a boot
-target with a complete port planned.
+MCUboot is not dependent on any specific operating system and hardware and
+relies on hardware porting layers from the operating system it works with.
+Currently, MCUboot works with the following operating systems and SoCs:
+- [Zephyr](https://www.zephyrproject.org/)
+- [Apache Mynewt](https://mynewt.apache.org/)
+- [Apache NuttX](https://nuttx.apache.org/)
+- [RIOT](https://www.riot-os.org/)
+- [Mbed OS](https://os.mbed.com/)
+- [Espressif IDF](https://idf.espressif.com/)
+- [Cypress/Infineon](https://www.cypress.com/)
-## Using MCUboot
+RIOT is supported only as a boot target. We will accept any new
+port contributed by the community once it is good enough.
-Instructions for different operating systems can be found here:
+## MCUboot How-tos
+
+See the following pages for instructions on using MCUboot with different
+operating systems and SoCs:
- [Zephyr](docs/readme-zephyr.md)
-- [Mynewt](docs/readme-mynewt.md)
+- [Apache Mynewt](docs/readme-mynewt.md)
+- [Apache NuttX](docs/readme-nuttx.md)
- [RIOT](docs/readme-riot.md)
-- [Mbed-OS](docs/readme-mbed.md)
-- [NuttX](docs/readme-nuttx.md)
+- [Mbed OS](docs/readme-mbed.md)
- [Espressif IDF](docs/readme-espressif.md)
-- [Simulator](sim/README.rst)
+- [Cypress/Infineon](boot/cypress/readme.md)
+
+There are also instructions for the [Simulator](sim/README.rst).
## Roadmap
The issues being planned and worked on are tracked using GitHub issues. To
-participate please visit:
+give your input, visit [MCUboot GitHub
+Issues](https://github.com/mcu-tools/mcuboot/issues).
-[MCUboot GitHub Issues](https://github.com/mcu-tools/mcuboot/issues)
+## Source files
-~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
-, but it is now deprecated.~~
+You can find additional documentation on the bootloader in the source files.
+For more information, use the following links:
+- [boot/bootutil](https://github.com/mcu-tools/mcuboot/tree/main/boot/bootutil) - The core of the bootloader itself.
+- [boot/boot\_serial](https://github.com/mcu-tools/mcuboot/tree/main/boot/boot_serial) - Support for serial upgrade within the bootloader itself.
+- [boot/zephyr](https://github.com/mcu-tools/mcuboot/tree/main/boot/zephyr) - Port of the bootloader to Zephyr.
+- [boot/mynewt](https://github.com/mcu-tools/mcuboot/tree/main/boot/mynewt) - Bootloader application for Apache Mynewt.
+- [boot/nuttx](https://github.com/mcu-tools/mcuboot/tree/main/boot/nuttx) - Bootloader application and port of MCUboot interfaces for Apache NuttX.
+- [boot/mbed](https://github.com/mcu-tools/mcuboot/tree/main/boot/mbed) - Port of the bootloader to Mbed OS.
+- [boot/espressif](https://github.com/mcu-tools/mcuboot/tree/main/boot/espressif) - Bootloader application and MCUboot port for Espressif SoCs.
+- [boot/cypress](https://github.com/mcu-tools/mcuboot/tree/main/boot/cypress) - Bootloader application and MCUboot port for Cypress/Infineon SoCs.
+- [imgtool](https://github.com/mcu-tools/mcuboot/tree/main/scripts/imgtool.py) - A tool to securely sign firmware images for booting by MCUboot.
+- [sim](https://github.com/mcu-tools/mcuboot/tree/main/sim) - A bootloader simulator for testing and regression.
-## Browsing
+## Joining the project
-Information and documentation on the bootloader are stored within the source.
+Developers are welcome!
-~~It was previously also documented on confluence:
-[MCUboot Confluence](https://runtimeco.atlassian.net/wiki/discover/all-updates)
-however, it is now deprecated and not currently maintained~~
-
-For more information in the source, here are some pointers:
-
-- [boot/bootutil](boot/bootutil): The core of the bootloader itself.
-- [boot/boot\_serial](boot/boot_serial): Support for serial upgrade within the bootloader itself.
-- [boot/zephyr](boot/zephyr): Port of the bootloader to Zephyr
-- [boot/mynewt](boot/mynewt): Mynewt bootloader app
-- [boot/nuttx](boot/nuttx): Bootloader application and port of MCUboot interfaces for NuttX.
-- [boot/espressif](boot/espressif): Bootloader application and MCUboot port for Espressif SoCs.
-- [imgtool](scripts/imgtool.py): A tool to securely sign firmware images for booting by MCUboot.
-- [sim](sim): A bootloader simulator for testing and regression
-
-## Joining
-
-Developers welcome!
+Use the following links to join or see more about the project:
* [Our developer mailing list](https://groups.io/g/MCUBoot)
* [Our Slack channel](https://mcuboot.slack.com/) <br />
diff --git a/docs/index.md b/docs/index.md
index 4dae701..02b7d09 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,77 +1,89 @@
# MCUboot
+MCUboot is a secure bootloader for 32-bits microcontrollers.
+
## Overview
-MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to
-define a common infrastructure for the bootloader, system flash layout on
-microcontroller systems, and to provide a secure bootloader that enables
-easy software upgrade.
+MCUboot defines a common infrastructure for the bootloader and the system flash
+layout on microcontroller systems, and provides a secure bootloader that
+enables easy software upgrade.
-MCUboot is operating system and hardware independent and relies on
-hardware porting layers from the operating system it works with. Currently
-MCUboot works with both the Apache Mynewt, and Zephyr operating systems, but
-more ports are planned in the future. RIOT is currently supported as a boot
-target with a complete port planned.
+MCUboot is not dependent on any specific operating system and hardware and
+relies on hardware porting layers from the operating system it works with.
+Currently MCUboot works with the following operating systems and SoCs:
+- [Zephyr](https://www.zephyrproject.org/)
+- [Apache Mynewt](https://mynewt.apache.org/)
+- [Apache NuttX](https://nuttx.apache.org/)
+- [RIOT](https://www.riot-os.org/)
+- [Mbed OS](https://os.mbed.com/)
+- [Espressif IDF](https://idf.espressif.com/)
+- [Cypress/Infineon](https://www.cypress.com/)
-MCUboot is an open governance project. See the [membership
+RIOT is supported only as a boot target. We will accept any new port
+contributed by the community once it is good enough.
+
+MCUboot is an open governance project. See the [membership
list](https://github.com/mcu-tools/mcuboot/wiki/Members) for current
members, and the
-[charter](https://github.com/mcu-tools/mcuboot/wiki/MCUboot-Project-Charter)
+[project charter](https://github.com/mcu-tools/mcuboot/wiki/MCUboot-Project-Charter)
for more details.
-## Contents
+## Documentation
+
+The MCUboot documentation is composed of the following pages:
- General - this document
- [Release notes](release-notes.md)
- [Bootloader design](design.md)
- [Encrypted images](encrypted_images.md)
- [imgtool](imgtool.md) - image signing and key management
-- [ecdsa](ecdsa.md) - Information about ECDSA signature formats
+- [ECDSA](ecdsa.md) - information about ECDSA signature formats
- Usage instructions:
- [Zephyr](readme-zephyr.md)
- - [Mynewt](readme-mynewt.md)
+ - [Apache Mynewt](readme-mynewt.md)
+ - [Apache NuttX](readme-nuttx.md)
- [RIOT](readme-riot.md)
- - [Mbed-OS](readme-mbed.md)
+ - [Mbed OS](readme-mbed.md)
+ - [Espressif IDF](readme-espressif.md)
+ - [Cypress/Infineon](../boot/cypress/readme.md)
+ - [Simulator](../sim/README.rst)
+- Testing
+ - [Zephyr](testplan-zephyr.md) - Zephyr test plan
+ - [Apache Mynewt](testplan-mynewt.md) - Apache Mynewt test plan
+- [Release process](release.md)
+- [Project security policy](SECURITY.md)
- [Patch submission](SubmittingPatches.md) - information
on how to contribute to MCUboot
-- Testing
- - [Zephyr](testplan-zephyr.md) test plan
- - [mynewt](testplan-mynewt.md) test plan
-- [Release process](release.md)
-There is also a document about [signed images](signed_images.md) that is out
-of date. You should use `imgtool.py` instead of these documents.
+The documentation page about [signed images](signed_images.md) is currently
+outdated. Follow the instructions in [imgtool](imgtool.md) instead.
## Roadmap
-The issues being planned and worked on are tracked using GitHub issues. To participate
-please visit:
+The issues being planned and worked on are tracked using GitHub issues. To
+give your input, visit [MCUboot GitHub
+Issues](https://github.com/mcu-tools/mcuboot/issues).
-[MCUboot Issues](https://github.com/mcu-tools/mcuboot/issues)
+## Source files
-~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
-, but it is now deprecated.~~
+You can find additional documentation on the bootloader in the source files.
+For more information, use the following links:
+- [boot/bootutil](https://github.com/mcu-tools/mcuboot/tree/main/boot/bootutil) - The core of the bootloader itself.
+- [boot/boot\_serial](https://github.com/mcu-tools/mcuboot/tree/main/boot/boot_serial) - Support for serial upgrade within the bootloader itself.
+- [boot/zephyr](https://github.com/mcu-tools/mcuboot/tree/main/boot/zephyr) - Port of the bootloader to Zephyr.
+- [boot/mynewt](https://github.com/mcu-tools/mcuboot/tree/main/boot/mynewt) - Bootloader application for Apache Mynewt.
+- [boot/nuttx](https://github.com/mcu-tools/mcuboot/tree/main/boot/nuttx) - Bootloader application and port of MCUboot interfaces for Apache NuttX.
+- [boot/mbed](https://github.com/mcu-tools/mcuboot/tree/main/boot/mbed) - Port of the bootloader to Mbed OS.
+- [boot/espressif](https://github.com/mcu-tools/mcuboot/tree/main/boot/espressif) - Bootloader application and MCUboot port for Espressif SoCs.
+- [boot/cypress](https://github.com/mcu-tools/mcuboot/tree/main/boot/cypress) - Bootloader application and MCUboot port for Cypress/Infineon SoCs.
+- [imgtool](https://github.com/mcu-tools/mcuboot/tree/main/scripts/imgtool.py) - A tool to securely sign firmware images for booting by MCUboot.
+- [sim](https://github.com/mcu-tools/mcuboot/tree/main/sim) - A bootloader simulator for testing and regression.
-## Browsing
+## Joining the project
-Information and documentation on the bootloader is stored within the source.
+Developers are welcome!
-~~It was previously also documented on confluence: [Confluence page](https://runtimeco.atlassian.net/wiki/discover/all-updates)
-, but it is now deprecated and not currently maintained~~
-
-For more information in the source, here are some pointers:
-
-- [boot/bootutil](https://github.com/mcu-tools/mcuboot/tree/main/boot/bootutil): The core of the bootloader itself.
-- [boot/boot\_serial](https://github.com/mcu-tools/mcuboot/tree/main/boot/boot_serial): Support for serial upgrade within the bootloader itself.
-- [boot/zephyr](https://github.com/mcu-tools/mcuboot/tree/main/boot/zephyr): Port of the bootloader to Zephyr
-- [boot/mynewt](https://github.com/mcu-tools/mcuboot/tree/main/boot/mynewt): Mynewt bootloader app
-- [boot/mbed](https://github.com/mcu-tools/mcuboot/tree/main/boot/mbed): Port of the bootloader to Mbed-OS
-- [imgtool](https://github.com/mcu-tools/mcuboot/tree/main/scripts/imgtool.py): A tool to securely sign firmware images for booting by MCUboot.
-- [sim](https://github.com/mcu-tools/mcuboot/tree/main/sim): A bootloader simulator for testing and regression
-
-## Joining
-
-Developers welcome!
+Use the following links to join or see more about the project:
* [Our developer mailing list](https://groups.io/g/MCUBoot)
* [Our Slack channel](https://mcuboot.slack.com/) <br />