Mynewt 0.8.0 B2
Correct some bad paths in core's LICENSE.
1 file changed
tree: 758618664e68218f98b58c0484e6da08f92b210a
  1. apps/
  2. compiler/
  3. fs/
  4. hw/
  5. libs/
  6. net/
  7. scripts/
  8. sys/
  9. targets/
  10. .gitignore
  11. .rat-excludes
  12. DISCLAIMER
  13. LICENSE
  14. NOTICE
  15. project.yml
  16. README.md
  17. RELEASE_NOTES.md
  18. repository.yml
README.md

Apache Mynewt Core

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.

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 and run the following command from the core directory:

    $ newt test all

Browsing

If you are browsing around the source tree, and want to see some of the major functional chunks, here are a few pointers:

  • libs: Contains the core of the RTOS (libs/os and a number of helper libraries for building applications. Including a console (libs/console)), shell (libs/shell)), and libs/newtmgr), which supports software upgrade and remote fetching of logs and statistics.

  • net: Contains the networking packages. Right now, net/ contains the nimble package. Nimble is a full Bluetooth host and controller implementation, that is written from the ground up for the Apache Mynewt Operating System.

  • hw: Contains the HW specific support packages. Board Support Packages are located in hw/bsp, and the MCU specific definitions they rely on are located in hw/mcu.
    Finally, there is a HAL (Hardware Abstraction Layer) stored in hw/hal, even though the implementation of various HALs are stored in the MCU specific definitions.

  • fs: Contains the FS package (fs/fs)), which is the high-level Apache Mynewt file system API. A specific implementation of that FS, is NFFS (Newtron File System.) The Newtron file system is a FS that has been built from the ground-up in Apache Mynewt, designed to be optimized for small (64KB-32MB) flashes.

Sample Applications

In addition to some of the core packages, there are also some sample applications that show how to instantiate the Apache Mynewt system. These sample applications are located in the apps/ directory. They include:

  • boot: Project to build the bootloader for test platforms.
  • blinky: The minimal packages to build the OS, and blink a LED!
  • slinky: A slightly more complex project that includes the console and shell libraries.
  • bletiny: A stripped down interface to the Apache Mynewt Bluetooth stack.
  • test: Test project which can be compiled either with the simulator, or on a per-architecture basis.
    Test will run all the package's unit tests.

Getting Help

If you are having trouble using or contributing to Apache Mynewt, or just want to talk to a human about what you're working on, you can contact us via the developers mailing list.

Although not a formal channel, you can also find a number of core developers on the #mynewt channel on Freenode.

Also, be sure to checkout the Frequently Asked Questions for some help troubleshooting first.

Contributing

Anybody who works with Apache Mynewt can be a contributing member of the community that develops and deploys it. The process of releasing an operating system for microcontrollers is never done: and we welcome your contributions to that effort.

More information can be found at the Community section of the Apache Mynewt website, located here.

Pull Requests

Apache Mynewt welcomes pull request via Github. Discussions are done on Github, but depending on the topic, can also be relayed to the official Apache Mynewt developer mailing list dev@mynewt.incubator.apache.org.

If you are suggesting a new feature, please email the developer list directly, with a description of the feature you are planning to work on.

We do not merge pull requests directly on Github, all PRs will be pulled and pushed through https://git.apache.org/.

Filing Bugs

Bugs can be filed on the Apache Mynewt Bug Tracker.

Where possible, please include a self-contained reproduction case!

Feature Requests

Feature requests should also be filed on the Apache Mynewt Bug Tracker.
Please introduce it as a ticket type “Wish.”

Writing Tests

We love getting newt tests! Apache Mynewt is a huge undertaking, and improving code coverage is a win for every Apache Mynewt user.

Writing Documentation

Contributing to documentation (in addition to writing tests), is a great way to get involved with the Apache Mynewt project.

Pull requests to the apache-mynewt-site repository on Github are the best way to submit documentation. For more information on contributing to the documentation, the FAQ has some more information.

License

The code in this repository is all under either the Apache 2 license, or a license compatible with the Apache 2 license. See the LICENSE file for more information.

Export restrictions

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

The following provides more details on the included cryptographic software: https://tls.mbed.org/supported-ssl-ciphersuites.