You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ma...@apache.org on 2016/04/26 21:55:32 UTC
[12/14] incubator-mynewt-core git commit: update readme
update readme
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/commit/9ae1d4fc
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/tree/9ae1d4fc
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/diff/9ae1d4fc
Branch: refs/heads/develop
Commit: 9ae1d4fc7495b5e5b46c955ce93812f9b37c3dcb
Parents: cd728c0
Author: Sterling Hughes <st...@apache.org>
Authored: Tue Mar 29 18:23:14 2016 -0700
Committer: Sterling Hughes <st...@apache.org>
Committed: Tue Mar 29 18:23:14 2016 -0700
----------------------------------------------------------------------
README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++--------------
1 file changed, 49 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/blob/9ae1d4fc/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 02b6b3b..5315c48 100644
--- a/README.md
+++ b/README.md
@@ -19,24 +19,58 @@
#
-->
-# Apache Mynewt Core
+<img src="http://mynewt.apache.org/img/logo.svg" width="250" alt="Apache Mynewt">
## Overview
-This repository represents the core of the Apache Mynewt repository.
-It contains the major packages that make up the Apache Mynewt Operating
-System. For instructions on getting Apache Mynewt up & running, please
-see our [Getting Started Guide](https://mynewt.apache.org/os/get_started/introduction/).
-
-Apache Mynewt Core is not a standalone application, and it is not intended to
-be built by itself. To run the unit tests for all the packages contained in
-Apache Mynewt Core, install the Apache Newt tool as documented in the [Getting
-Started Guide](https://mynewt.apache.org/os/get_started/introduction/#newt) and
-run the following command from the core directory:
-
-```no-highlight
- $ newt test all
-```
+Apache Mynewt is an open-source operating system for tiny embedded devices.
+It's goal is to make it easy to develop applications for microcontroller
+environments, where power and cost are driving factors.
+
+It currently supports the following hardware platforms:
+
+* Arduino Zero and Zero Pro
+* Nordic NRF51 and NRF52
+* Rigado BMD-300
+* STM32F3 and STMF32F4
+* Native (simulated)
+
+Mynewt uses the [Newt](https://www.github.com/apache/incubator-mynewt-newt)
+build and package management system, which allows you to compose your OS, and
+only choose the components you need.
+
+This repository contains the core packages of the Apache Mynewt OS, including:
+
+* A Pre-emptive, Real Time OS Kernel
+* A open-source Bluetooth 4.2 stack (both Host & Controller), that completely replaces
+the proprietary SoftDevice on Nordic chipsets.
+ - Support for 251 byte packet size
+ - Support for all 4 roles concurrently - Broadcaster, Observer, Peripheral and Central
+ - Support for up to 32 simultaeneous connections.
+* A flash filesystem, NFFS, which is designed for tiny (128KB->16MB) flashes.
+* Bootloader support
+* Remote Software Upgrade
+* HAL and BSP infrastructure designed to abstract microcontroller specifics
+* Shell and Console support
+* Statistics and Logging Infrastructure
+
+For more information on the Mynewt OS, please visit our website [here](https://mynewt.apache.org/).
+If you'd like to get started, visit the [Getting Started Guide](https://mynewt.apache.org/os/get_started/introduction/).
+
+## Roadmap
+
+Mynewt is being actively developed. Some of the features we're currently working on:
+
+* Deep sleep: Mynewt OS will coordinate peripherals and processor to put the processor
+ to sleep when all tasks are idle.
+* Support for different boards and microcontroller architectures, we're working on:
+ - ESP8266
+ - Arduino Uno
+ - Arduino Mega
+* Enhancements to BLE 4.2 support:
+ - Security Manager Protocol
+ - LE Secure Connections
+ - Random addresses for link-layer security
## Browsing