README.md 2.55 KB
Newer Older
Fabio Utzig's avatar
Fabio Utzig committed
1
# [mcuboot](http://mcuboot.com/)
Sterling Hughes's avatar
Sterling Hughes committed
2

Fabio Utzig's avatar
Fabio Utzig committed
3
[![Coverity Scan Build Status](https://scan.coverity.com/projects/12307/badge.svg)][coverity]
4
[![Build/Test](https://img.shields.io/travis/JuulLabs-OSS/mcuboot/master.svg?label=travis-ci)][travis]
Fabio Utzig's avatar
Fabio Utzig committed
5
6

[coverity]: https://scan.coverity.com/projects/mcuboot
7
[travis]: https://travis-ci.org/JuulLabs-OSS/mcuboot
David Brown's avatar
David Brown committed
8

Andrzej Puzdrowski's avatar
Andrzej Puzdrowski committed
9
This is mcuboot version 1.7.0-rc1
Sterling Hughes's avatar
Sterling Hughes committed
10

11
MCUboot is a secure bootloader for 32-bit MCUs. The goal of MCUboot is to
Fabio Utzig's avatar
Fabio Utzig committed
12
13
define a common infrastructure for the bootloader, system flash layout on
microcontroller systems, and to provide a secure bootloader that enables
14
simple software upgrades.
Sterling Hughes's avatar
Sterling Hughes committed
15

16
MCUboot is operating system and hardware independent and relies on
17
18
19
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
Fabio Utzig's avatar
Fabio Utzig committed
20
target with a complete port planned.
Sterling Hughes's avatar
Sterling Hughes committed
21

22
23
24
25
26
27
## Using MCUboot

Instructions for different operating systems can be found here:
- [Zephyr](docs/readme-zephyr.md)
- [Mynewt](docs/readme-mynewt.md)
- [RIOT](docs/readme-riot.md)
28
- [Mbed-OS](docs/readme-mbed.md)
29
- [Simulator](sim/README.rst)
30

Sterling Hughes's avatar
Sterling Hughes committed
31
32
## Roadmap

33
34
The issues being planned and worked on are tracked using GitHub issues. To
participate please visit:
Sterling Hughes's avatar
Sterling Hughes committed
35

36
[MCUBoot GitHub Issues](https://github.com/JuulLabs-OSS/mcuboot/issues)
37
38
39

~~Issues were previously tracked on [MCUboot JIRA](https://runtimeco.atlassian.net/projects/MCUB/summary)
, but it is now deprecated.~~
Sterling Hughes's avatar
Sterling Hughes committed
40

Fabio Utzig's avatar
Fabio Utzig committed
41
## Browsing
Sterling Hughes's avatar
Sterling Hughes committed
42

43
Information and documentation on the bootloader are stored within the source.
Sterling Hughes's avatar
Sterling Hughes committed
44

45
46
47
~~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~~
Sterling Hughes's avatar
Sterling Hughes committed
48

Fabio Utzig's avatar
Fabio Utzig committed
49
For more information in the source, here are some pointers:
Sterling Hughes's avatar
Sterling Hughes committed
50

Fabio Utzig's avatar
Fabio Utzig committed
51
52
53
54
55
56
- [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
- [imgtool](scripts/imgtool.py): A tool to securely sign firmware images for booting by mcuboot.
- [sim](sim): A bootloader simulator for testing and regression
Sterling Hughes's avatar
Sterling Hughes committed
57

Fabio Utzig's avatar
Fabio Utzig committed
58
## Joining
Sterling Hughes's avatar
Sterling Hughes committed
59

Fabio Utzig's avatar
Fabio Utzig committed
60
Developers welcome!
Sterling Hughes's avatar
Sterling Hughes committed
61

Fabio Utzig's avatar
Fabio Utzig committed
62
* Our developer mailing list:
David Brown's avatar
David Brown committed
63
  https://groups.io/g/mcuboot
Fabio Utzig's avatar
Fabio Utzig committed
64
65
* Our Slack channel: https://mcuboot.slack.com/ <br />
  Get your invite [here!](https://join.slack.com/t/mcuboot/shared_invite/MjE2NDcwMTQ2MTYyLTE1MDA4MTIzNTAtYzgyZTU0NjFkMg)
Fabio Utzig's avatar
Fabio Utzig committed
66
* Our IRC channel: http://irc.freenode.net, #mcuboot