From 811205ec48006f4ff7b98a6558be6b72cf303c75 Mon Sep 17 00:00:00 2001 From: Fabio Utzig Date: Thu, 10 Aug 2017 14:55:27 -0300 Subject: [PATCH] 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 --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index dcda00a3..4b4d94e4 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ -# mcuboot +# [mcuboot](http://mcuboot.com/) + +[![Coverity Scan Build Status](https://scan.coverity.com/projects/12307/badge.svg)][coverity] +[![Build/Test](https://img.shields.io/travis/runtimeco/mcuboot/master.svg?label=travis-ci)][travis] + +[coverity]: https://scan.coverity.com/projects/mcuboot +[travis]: https://travis-ci.org/runtimeco/mcuboot This is mcuboot, version 0.9.0 -## Overview - -MCUBoot is a secure bootloader for 32-bit MCUs. The goal of MCUBoot is to -define a common infrastructure for the bootloader, system flash layout on -microcontroller systems, and to provide a secure bootloader that enables +MCUBoot is a secure bootloader for 32-bit MCUs. The goal of MCUBoot is to +define a common infrastructure for the bootloader, system flash layout on +microcontroller systems, and to provide a secure bootloader that enables easy software upgrade. -MCUboot is operating system and hardware independent, and relies on +MCUboot is operating system and hardware independent, and relies on 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 @@ -18,17 +22,17 @@ target with a complete port planned. ## Roadmap The issues being planned and worked on are tracked on Jira. To participate -please visit: +please visit: https://runtimeco.atlassian.net/projects/MCUB/summary -## Browsing +## Browsing Information and documentation on the bootloader is stored within the source, and on confluence: https://runtimeco.atlassian.net/wiki/discover/all-updates -For more information in the source, here are some pointers: +For more information in the source, here are some pointers: - [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.