You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by st...@apache.org on 2016/03/14 23:51:14 UTC

incubator-mynewt-core git commit: bit more of an update of the README

Repository: incubator-mynewt-core
Updated Branches:
  refs/heads/develop fa7e1694d -> edd5b1f7c


bit more of an update of the 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/edd5b1f7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/tree/edd5b1f7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/diff/edd5b1f7

Branch: refs/heads/develop
Commit: edd5b1f7cc1f109a768049522d72026c9d02fa5e
Parents: fa7e169
Author: Sterling Hughes <st...@apache.org>
Authored: Mon Mar 14 15:51:03 2016 -0700
Committer: Sterling Hughes <st...@apache.org>
Committed: Mon Mar 14 15:51:03 2016 -0700

----------------------------------------------------------------------
 README.md | 69 ++++++++++++++++++++++++++++++++++------------------------
 1 file changed, 41 insertions(+), 28 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/blob/edd5b1f7/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 7a3e4fc..7c5202e 100644
--- a/README.md
+++ b/README.md
@@ -35,9 +35,10 @@ major functional chunks, here are a few pointers:
 
 - libs: Contains the core of the RTOS ([libs/os](https://github.com/apache/incubator-mynewt-core/tree/master/libs/os) 
 and a number of helper libraries for building applications.  Including a 
-console (libs/console), 
-shell (libs/shell), and newtmgr, which supports software upgrade and 
-remote fetching of logs and statistics (libs/newtmgr).  
+console ([libs/console](https://github.com/apache/incubator-mynewt-core/tree/master/libs/console))), 
+shell ([libs/shell](https://github.com/apache/incubator-mynewt-core/tree/master/libs/shell))), and 
+[libs/newtmgr](https://github.com/apache/incubator-mynewt-core/tree/master/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](https://github.com/apache/incubator-mynewt-core/tree/master/net/nimble)
@@ -45,13 +46,16 @@ 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
+are located in [hw/bsp](https://github.com/apache/incubator-mynewt-core/tree/master/hw/bsp), 
+and the MCU specific definitions they rely on are located in 
+[hw/mcu](https://github.com/apache/incubator-mynewt-core/tree/master/hw/mcu).  
+Finally, there is a HAL (Hardware Abstraction Layer) stored in 
+[hw/hal](https://github.com/apache/incubator-mynewt-core/tree/master/hw/hal), even 
+though the implementation of various HALs are stored in the MCU specific definitions.  
+
+- fs: Contains the FS package ([fs/fs](https://github.com/apache/incubator-mynewt-core/tree/master/fs/fs))), 
+which is the high-level Apache Mynewt file system API.   A specific implementation of that FS, is 
+[NFFS](https://github.com/apache/incubator-mynewt-core/tree/master/fs/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.
@@ -63,15 +67,30 @@ 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. 
+* [boot](https://github.com/apache/incubator-mynewt-core/tree/master/apps/boot): 
+  Project to build the bootloader for test platforms. 
+* [blinky](https://github.com/apache/incubator-mynewt-core/tree/master/apps/blinky): The 
+  minimal packages to build the OS, and blink a LED!  
+* [slinky](https://github.com/apache/incubator-mynewt-core/tree/master/apps/slinky): A 
+  slightly more complex project that includes the console and shell libraries. 
+* [bletiny](https://github.com/apache/incubator-mynewt-core/tree/master/apps/bletiny): A 
+  stripped down interface to the Apache Mynewt Bluetooth stack.
+* [test](https://github.com/apache/incubator-mynewt-core/tree/master/apps/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](mailto:dev@mynewt.incubator.apache.org).  
+
+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](https://mynewt.apache.org/faq/answers)
+for some help troubleshooting first.
 
 # Contributing 
 
@@ -80,6 +99,9 @@ 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](https://mynewt.apache.org/community).  
+
 ## Pull Requests
 
 Apache Mynewt welcomes pull request via Github.  Discussions are done on Github,
@@ -120,15 +142,6 @@ way to submit documentation.  For more information on contributing to the
 documentation, the [FAQ](http://mynewt.apache.org/faq/answers/) has some 
 more information.
 
-## Getting Help
-
-If you are having trouble 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](mailto:dev@mynewt.incubator.apache.org).  
-
-Although not a formal channel, you can also find a number of core developers
-on the #mynewt channel on Freenode.
-
 # License 
 
 The code in this repository is all under either the Apache 2 license, or a