OrgZephyr/mcuboot
OrgZephyr
/
mcuboot
mirror of https://github.com/zephyrproject-rtos/mcuboot.git
1
0
Fork 0
Code Issues Releases Wiki Activity
mcuboot/README.md

86 lines
4.5 KiB
Markdown
Raw Normal View History

doc: Fixed consistency of MCUboot Fixed the consistency of the case used in the term MCUboot. Signed-off-by: Francesco Servidio <francesco.servidio@nordicsemi.no>
2021-10-20 21:27:16 +08:00
# [MCUboot](http://mcuboot.com/)
update README
2017-02-08 05:12:19 +08:00
ci: update workflows names and add more badges Fix workflows names on yaml root to be able to use them to refer to the workflow. Add badges for pypi, workflows and license. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-11-12 21:45:07 +08:00
[![Package on PyPI](https://img.shields.io/pypi/v/imgtool.svg)][pypi]
Add badges, link url - Add coverity and travis-ci badges - Link title to project url - Remove version information from header text Signed-off-by: Fabio Utzig <utzig@apache.org>
2017-08-11 01:55:27 +08:00
[![Coverity Scan Build Status](https://scan.coverity.com/projects/12307/badge.svg)][coverity]
ci: update workflows names and add more badges Fix workflows names on yaml root to be able to use them to refer to the workflow. Add badges for pypi, workflows and license. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-11-12 21:45:07 +08:00
[![Build Status (Sim)](https://github.com/mcu-tools/mcuboot/workflows/Sim/badge.svg)][sim]
[![Build Status (Mynewt)](https://github.com/mcu-tools/mcuboot/workflows/Mynewt/badge.svg)][mynewt]
Add Espressif build status badge Add new badge to easily check build status for Espressif CI. Signed-off-by: Fabio Utzig <utzig@apache.org>
2023-08-10 02:05:12 +08:00
[![Build Status (Espressif)](https://github.com/mcu-tools/mcuboot/workflows/Espressif/badge.svg)][espressif]
ci: update workflows names and add more badges Fix workflows names on yaml root to be able to use them to refer to the workflow. Add badges for pypi, workflows and license. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-11-12 21:45:07 +08:00
[![Publishing Status (imgtool)](https://github.com/mcu-tools/mcuboot/workflows/imgtool/badge.svg)][imgtool]
Migrate master->main Change references in CI and docs from 'master' to 'main' as the primary branch has been renamed. Signed-off-by: David Brown <david.brown@linaro.org>
2021-05-15 00:12:10 +08:00
[![Build Status (Travis CI)](https://img.shields.io/travis/mcu-tools/mcuboot/main.svg?label=travis-ci)][travis]
ci: update workflows names and add more badges Fix workflows names on yaml root to be able to use them to refer to the workflow. Add badges for pypi, workflows and license. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-11-12 21:45:07 +08:00
[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)][license]
Add badges, link url - Add coverity and travis-ci badges - Link title to project url - Remove version information from header text Signed-off-by: Fabio Utzig <utzig@apache.org>
2017-08-11 01:55:27 +08:00
ci: update workflows names and add more badges Fix workflows names on yaml root to be able to use them to refer to the workflow. Add badges for pypi, workflows and license. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-11-12 21:45:07 +08:00
[pypi]: https://pypi.org/project/imgtool/
Add badges, link url - Add coverity and travis-ci badges - Link title to project url - Remove version information from header text Signed-off-by: Fabio Utzig <utzig@apache.org>
2017-08-11 01:55:27 +08:00
[coverity]: https://scan.coverity.com/projects/mcuboot
ci: use names to refer to workflows in badges Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-11-13 00:17:46 +08:00
[sim]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Sim
[mynewt]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Mynewt
Add Espressif build status badge Add new badge to easily check build status for Espressif CI. Signed-off-by: Fabio Utzig <utzig@apache.org>
2023-08-10 02:05:12 +08:00
[espressif]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:Espressif
ci: use names to refer to workflows in badges Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-11-13 00:17:46 +08:00
[imgtool]: https://github.com/mcu-tools/mcuboot/actions?query=workflow:imgtool
doc: fix github urls to use the new org Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
2020-11-10 23:35:04 +08:00
[travis]: https://travis-ci.org/mcu-tools/mcuboot
Migrate master->main Change references in CI and docs from 'master' to 'main' as the primary branch has been renamed. Signed-off-by: David Brown <david.brown@linaro.org>
2021-05-15 00:12:10 +08:00
[license]: https://github.com/mcu-tools/mcuboot/blob/main/LICENSE
Bump version to 0.9.0-rc2 Version is stored in repository.yaml for mynewt. Otherwise, put a single mention of it in the README.md. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-27 09:02:33 +08:00
Preps for 2.1.0 release Update version information for 2.1.0 release. Signed-off-by: David Brown <david.brown@linaro.org>
2024-05-06 23:52:20 +08:00
This is MCUboot version 2.1.0
update README
2017-02-08 05:12:19 +08:00
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>
2021-11-03 20:48:58 +08:00
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 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/)
readme.md: remove "IDF" from Espressif reference This change is to avoid misunderstanding as IDF is not supported on top of MCUboot. The Espressif port acts as a bare metal bootloader that can be used on Espressif chips to boot supported OSes (like Zephyr or NuttX). Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-01-27 05:13:50 +08:00
- [Espressif](https://www.espressif.com/)
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>
2021-11-03 20:48:58 +08:00
- [Cypress/Infineon](https://www.cypress.com/)
RIOT is supported only as a boot target. We will accept any new
port contributed by the community once it is good enough.
## MCUboot How-tos
See the following pages for instructions on using MCUboot with different
operating systems and SoCs:
docs: Link to instructions from landing pages Link to usage instructions from the main README file and from docs/index.md so that the usage is visible from the root documentation files. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-01-23 22:43:46 +08:00
- [Zephyr](docs/readme-zephyr.md)
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>
2021-11-03 20:48:58 +08:00
- [Apache Mynewt](docs/readme-mynewt.md)
- [Apache NuttX](docs/readme-nuttx.md)
docs: Link to instructions from landing pages Link to usage instructions from the main README file and from docs/index.md so that the usage is visible from the root documentation files. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-01-23 22:43:46 +08:00
- [RIOT](docs/readme-riot.md)
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>
2021-11-03 20:48:58 +08:00
- [Mbed OS](docs/readme-mbed.md)
readme.md: remove "IDF" from Espressif reference This change is to avoid misunderstanding as IDF is not supported on top of MCUboot. The Espressif port acts as a bare metal bootloader that can be used on Espressif chips to boot supported OSes (like Zephyr or NuttX). Signed-off-by: Almir Okato <almir.okato@espressif.com>
2022-01-27 05:13:50 +08:00
- [Espressif](docs/readme-espressif.md)
docs: Fix case of Cypress readme file Fix the case of the cypress readme to fix dead links in the docs. Signed-off-by: David Brown <david.brown@linaro.org>
2022-05-17 22:50:55 +08:00
- [Cypress/Infineon](boot/cypress/README.md)
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>
2021-11-03 20:48:58 +08:00
There are also instructions for the [Simulator](sim/README.rst).
docs: Link to instructions from landing pages Link to usage instructions from the main README file and from docs/index.md so that the usage is visible from the root documentation files. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-01-23 22:43:46 +08:00
update README
2017-02-08 05:12:19 +08:00
## Roadmap
Add deprecated warning to Jira and Confluence links This will fix #336 by adding deprecation warning to Jira and Confluence links as these are not used by the project anymore. Signed-off-by: Sigvart M. Hovland <sigvart.m@gmail.com>
2018-09-30 00:58:55 +08:00
The issues being planned and worked on are tracked using GitHub issues. To
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>
2021-11-03 20:48:58 +08:00
give your input, visit [MCUboot GitHub
Issues](https://github.com/mcu-tools/mcuboot/issues).
update README
2017-02-08 05:12:19 +08:00
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>
2021-11-03 20:48:58 +08:00
## Source files
update README
2017-02-08 05:12:19 +08:00
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>
2021-11-03 20:48:58 +08:00
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.
update README
2017-02-08 05:12:19 +08:00
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>
2021-11-03 20:48:58 +08:00
## Joining the project
update README
2017-02-08 05:12:19 +08:00
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>
2021-11-03 20:48:58 +08:00
Developers are welcome!
update README
2017-02-08 05:12:19 +08:00
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>
2021-11-03 20:48:58 +08:00
Use the following links to join or see more about the project:
update README
2017-02-08 05:12:19 +08:00
doc: Remove outdated IRC links Removed outdated IRC links from index.md and readme.md. Slightly reformatted the final links in index.md and readme.md. Signed-off-by: Francesco Servidio <francesco.servidio@nordicsemi.no>
2021-10-20 20:57:50 +08:00
* [Our developer mailing list](https://groups.io/g/MCUBoot)
docs: Replace Slack channel links with Discord Replace Slack channel links with MCUboot Discord channel as the discussions have moved there. Signed-off-by: David Vincze <david.vincze@arm.com> Change-Id: I132279574e674408dffc9ed377d216775a54fd56
2024-05-29 20:17:02 +08:00
* [Our Discord channel](https://discord.com/channels/1106321706588577904/1106322802308550716) <br />
Get [your invite](https://discord.com/invite/5PpXhvda5p)