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

71 lines
3.0 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.
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
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
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)
- [design](design.md): for the design
- [imgtool](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:
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)
- [Mynewt](readme-mynewt.md)
- [RIOT](readme-riot.md)
- [Patch submission](SubmittingPatches.md) for information
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
on how to contribute to mcuboot.
- Testing
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
- The [Zephyr](testplan-zephyr.md) test plan.
- The [mynewt](testplan-mynewt.md) test plan.
- Our [release process](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
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
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.
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
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 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
Fix main github repo links in docs This updates all references from github.com/runtimeco to github.com/JuulLabs-OSS in docs and yml files. Signed-off-by: Fabio Utzig <utzig@apache.org>
2018-11-16 04:48:59 +08:00
[MCUboot Issues](https://github.com/JuulLabs-OSS/mcuboot/issues)
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
~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
, but it is now deprecated.~~
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
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
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
Information and documentation on the bootloader is stored within the source.
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
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
~~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~~
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
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
Fix main github repo links in docs This updates all references from github.com/runtimeco to github.com/JuulLabs-OSS in docs and yml files. Signed-off-by: Fabio Utzig <utzig@apache.org>
2018-11-16 04:48:59 +08:00
- [boot/bootutil](https://github.com/JuulLabs-OSS/mcuboot/tree/master/boot/bootutil): The core of the bootloader itself.
- [boot/boot\_serial](https://github.com/JuulLabs-OSS/mcuboot/tree/master/boot/boot_serial): Support for serial upgrade within the bootloader itself.
- [boot/zephyr](https://github.com/JuulLabs-OSS/mcuboot/tree/master/boot/zephyr): Port of the bootloader to Zephyr
- [boot/mynewt](https://github.com/JuulLabs-OSS/mcuboot/tree/master/boot/mynewt): Mynewt bootloader app
- [imgtool](https://github.com/JuulLabs-OSS/mcuboot/tree/master/scripts/imgtool.py): A tool to securely sign firmware images for booting by MCUboot.
- [sim](https://github.com/JuulLabs-OSS/mcuboot/tree/master/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
## 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)