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

68 lines
2.9 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
## Overview
Minor doc cleanups Fix spelling of MCUboot, and remove a duplicated link. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-13 01:37:29 +08:00
MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to
Remove eol whitespace from doc file Remove these extraneous end of line spaces. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:06:38 +08:00
define a common infrastructure for the bootloader, system flash layout on
microcontroller systems, and to provide a secure bootloader that enables
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
easy software upgrade.
Remove eol whitespace from doc file Remove these extraneous end of line spaces. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:06:38 +08:00
MCUboot is operating system and hardware independent, and relies on
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
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.
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
## Contents
- General: this document
Release notes for 1.0.0. Move the release notes document into the docs directory, and convert to Markdown so that it can be rendered on the project's website. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-13 00:59:39 +08:00
- [Release notes]({% link release-notes.md %})
Convert design document to Markdown The complex blocks are just verbatim, and some of the outline-style blocks are keps as pre formatted until we decide the right way to format them. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-13 01:53:20 +08:00
- [design]({% link design.md %}): for the design
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
- [imgtool]({% link imgtool.md %}): The image signing and key management
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:
- [Zephyr]({% link readme-zephyr.md %})
- [Mynewt]({% link readme-mynewt.md %})
- [RIOT]({% link readme-riot.md %})
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
- [Patch submission]({% link SubmittingPatches.md %}) for information
on how to contribute to mcuboot.
- Testing
- The [Zephyr]({% link testplan-zephyr.md %}) test plan.
- The [mynewt]({% link testplan-mynewt.md %}) test plan.
Document the release process An initial document describing the mechanics of how a release is made. This is a start of documenting our full development process. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-13 00:36:19 +08:00
- Our [release process]({% link release.md %}).
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
There is also a document about [signed images]({% link
signed_images.md %}) that is out of date. You should use `imgtool.py`
instead of these documents.
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
The issues being planned and worked on are tracked on Jira. To participate
Remove eol whitespace from doc file Remove these extraneous end of line spaces. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:06:38 +08:00
please visit:
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 JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
Remove eol whitespace from doc file Remove these extraneous end of line spaces. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:06:38 +08:00
## Browsing
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
Information and documentation on the bootloader is stored within the source, and on confluence:
[Confluence page](https://runtimeco.atlassian.net/wiki/discover/all-updates)
Remove eol whitespace from doc file Remove these extraneous end of line spaces. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 03:06:38 +08:00
For more information in the source, here are some pointers:
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
- [boot/bootutil](https://github.com/runtimeco/mcuboot/tree/master/boot/bootutil): The core of the bootloader itself.
- [boot/boot\_serial](https://github.com/runtimeco/mcuboot/tree/master/boot/boot_serial): Support for serial upgrade within the bootloader itself.
- [boot/zephyr](https://github.com/runtimeco/mcuboot/tree/master/boot/zephyr): Port of the bootloader to Zephyr
- [boot/mynewt](https://github.com/runtimeco/mcuboot/tree/master/boot/mynewt): Mynewt bootloader app
Fix `imgtool.py` link in main webpage URL was referencing old location for this script. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-28 23:46:54 +08:00
- [imgtool](https://github.com/runtimeco/mcuboot/tree/master/scripts/imgtool.py): A tool to securely sign firmware images for booting by MCUboot.
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
- [sim](https://github.com/runtimeco/mcuboot/tree/master/sim): A bootloader simulator for testing and regression
## Joining
Developers welcome!
* [Our developer mailing list](http://lists.runtime.co/mailman/listinfo/dev-mcuboot_lists.runtime.co)
* [Our Slack channel](https://mcuboot.slack.com/)<br />
Get your invite [here!](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
* [Our IRC channel](http://irc.freenode.net), channel #mcuboot ([IRC
link](irc://chat.freenode.net/#mcuboot)