sjanc closed pull request #1094: Update README with notes about NimBLE moving
to own repo
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/README.md b/README.md
index 43dbb5197c..15cc5b5731 100644
@@ -68,10 +68,12 @@ This repository contains the core packages of the Apache
Mynewt OS, including:
* A Pre-emptive, Real Time OS Kernel
* A open-source Bluetooth 5.0 stack (both Host & Controller), NimBLE, that
completely replaces the proprietary SoftDevice on Nordic chipsets.
+<span style="color:red">**NOTE** NimBLE sources were moved to separate
- Support for 251 byte packet size
- Support for all 4 roles concurrently - Broadcaster, Observer, Peripheral
- Support for up to 32 simultaneous connections.
- Legacy and SC (secure connections) SMP support (pairing and bonding).
+ - Advertising Extensions.
* A flash filesystem, NFFS, which is designed for tiny (128KB->16MB) flashes.
* Flash Circular Buffer
@@ -100,9 +102,10 @@ shell
- mgmt: Contains the management libraries for newtmgr
which supports software upgrade and remote fetching of logs and statistics.
- net: Contains the networking packages. Highlights of the net directory are
the NimBLE and IP packages.
is a full Bluetooth host and controller implementation, that is written
-from the ground up for the Apache Mynewt Operating System.
+from the ground up for the Apache Mynewt Operating System (due to code moved to
+separate repo this folder contains only compatibility package files).
[ip](https://github.com/apache/mynewt-core/tree/master/net/ip) is a port of
LWIP, a complete IPv4 and IPv6 implementation.
- hw: Contains the HW specific support packages. Board Support Packages
diff --git a/net/nimble/README.md b/net/nimble/README.md
new file mode 100644
@@ -0,0 +1,26 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+NimBLE sources were moved to separate
+This folder contains only packages configuration files for backward
+compatibility and will be removed eventually.
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
Apache Git Services