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

93 lines
4.3 KiB
Markdown
Raw Normal View History

Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
# MCUboot
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.
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +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
## Overview
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +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 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/)
- [Espressif IDF](https://idf.espressif.com/)
- [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 is an open governance project. See the [membership
docs: Add links to wikipage on project Update the main webpage to contain links to the wiki page docs on the project charter, and the membership page. Signed-off-by: David Brown <david.brown@linaro.org>
2021-04-02 04:39:23 +08:00
list](https://github.com/mcu-tools/mcuboot/wiki/Members) for current
members, and the
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
[project charter](https://github.com/mcu-tools/mcuboot/wiki/MCUboot-Project-Charter)
docs: Add links to wikipage on project Update the main webpage to contain links to the wiki page docs on the project charter, and the membership page. Signed-off-by: David Brown <david.brown@linaro.org>
2021-04-02 04:39:23 +08:00
for more details.
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
## Documentation
The MCUboot documentation is composed of the following pages:
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
docs: add link to encrypted_images.md and cleanup Add a link to the topic about encrypted images to the start page. Clean up the existing links to make the table of contents more consistent. Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
2019-11-01 23:32:20 +08:00
- General - this document
Change all doc links to use relative names Github pages assumes that links to files using relative names point to the same location so this should work both when accessing through the github browser and mcuboot.com Signed-off-by: Fabio Utzig <utzig@apache.org>
2018-02-13 01:31:32 +08:00
- [Release notes](release-notes.md)
docs: add link to encrypted_images.md and cleanup Add a link to the topic about encrypted images to the start page. Clean up the existing links to make the table of contents more consistent. Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
2019-11-01 23:32:20 +08:00
- [Bootloader design](design.md)
- [Encrypted images](encrypted_images.md)
- [imgtool](imgtool.md) - image signing and key management
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
- [ECDSA](ecdsa.md) - information about ECDSA signature formats
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
- Usage instructions:
Change all doc links to use relative names Github pages assumes that links to files using relative names point to the same location so this should work both when accessing through the github browser and mcuboot.com Signed-off-by: Fabio Utzig <utzig@apache.org>
2018-02-13 01:31:32 +08:00
- [Zephyr](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](readme-mynewt.md)
- [Apache NuttX](readme-nuttx.md)
Change all doc links to use relative names Github pages assumes that links to files using relative names point to the same location so this should work both when accessing through the github browser and mcuboot.com Signed-off-by: Fabio Utzig <utzig@apache.org>
2018-02-13 01:31:32 +08:00
- [RIOT](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](readme-mbed.md)
- [Espressif IDF](readme-espressif.md)
- [Cypress/Infineon](../boot/cypress/readme.md)
- [Simulator](../sim/README.rst)
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
- Testing
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
- [Zephyr](testplan-zephyr.md) - Zephyr test plan
- [Apache Mynewt](testplan-mynewt.md) - Apache Mynewt test plan
docs: add link to encrypted_images.md and cleanup Add a link to the topic about encrypted images to the start page. Clean up the existing links to make the table of contents more consistent. Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
2019-11-01 23:32:20 +08:00
- [Release process](release.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
- [Project security policy](SECURITY.md)
- [Patch submission](SubmittingPatches.md) - information
on how to contribute to MCUboot
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +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
The documentation page about [signed images](signed_images.md) is currently
outdated. Follow the instructions in [imgtool](imgtool.md) instead.
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
## Roadmap
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
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).
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +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
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +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.
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +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
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +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!
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +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:
Rearrange docs for gh-pages Github pages allows the documentation to be in the master branch in a 'docs' directory to be rendered as the main site (mcuboot.com). Rename this directory, and pull in the documentation files from the old gh-pages branch. The main index.md page does not link to the rest of the docs yet, and that change can be made in a future patch. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:04:34 +08:00
docs: fix mailing list URL Signed-off-by: Fabio Utzig <utzig@apache.org>
2020-01-22 23:26:04 +08:00
* [Our developer mailing list](https://groups.io/g/MCUBoot)
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 Slack channel](https://mcuboot.slack.com/) <br />
Get [your invite](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
docs: Add links to wikipage on project Update the main webpage to contain links to the wiki page docs on the project charter, and the membership page. Signed-off-by: David Brown <david.brown@linaro.org>
2021-04-02 04:39:23 +08:00
* [Current members](https://github.com/mcu-tools/mcuboot/wiki/Members)
* [Project charter](https://github.com/mcu-tools/mcuboot/wiki/MCUboot-Project-Charter)