You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2015/12/18 21:27:05 UTC
[07/17] incubator-mynewt-site git commit: new chapter names and
references, updated but not complete Windows instructions for blinky project
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2c998465/index.html
----------------------------------------------------------------------
diff --git a/index.html b/index.html
index fffd94b..0ebe994 100644
--- a/index.html
+++ b/index.html
@@ -56,6 +56,9 @@
<ul>
+ <li class="toctree-l3"><a href="#asf-incubator-project">ASF Incubator Project</a></li>
+
+
<li class="toctree-l3"><a href="#objective-of-mynewt">Objective of Mynewt</a></li>
<li><a class="toctree-l4" href="#project-information-links">Project Information Links</a></li>
@@ -78,33 +81,33 @@
<li>
<ul class="subnav">
- <li><span>Chapter1 - Get Started</span></li>
+ <li><span>Get Started</span></li>
<li class="toctree-l1 ">
- <a class="" href="chapter1/newt_concepts/">Newt Concepts</a>
+ <a class="" href="get_started/newt_concepts/">Newt Concepts</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter1/project1/">Blinky, The First Project</a>
+ <a class="" href="get_started/project1/">Blinky, The First Project</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter1/how_to_edit_docs/">How to edit docs</a>
+ <a class="" href="get_started/how_to_edit_docs/">How to edit docs</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter1/try_markdown/">Sample doc to edit</a>
+ <a class="" href="get_started/try_markdown/">Sample doc to edit</a>
</li>
@@ -114,26 +117,26 @@
<li>
<ul class="subnav">
- <li><span>Chapter2 - Get Acclimated</span></li>
+ <li><span>Get Acclimated</span></li>
<li class="toctree-l1 ">
- <a class="" href="chapter2/vocabulary/">Understanding Newt Terms</a>
+ <a class="" href="get_acclimated/vocabulary/">Understanding Newt Terms</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter2/project2/">Project 2</a>
+ <a class="" href="get_acclimated/project2/">Project 2</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter2/project3/">Project 3</a>
+ <a class="" href="get_acclimated/project3/">Project 3</a>
</li>
@@ -143,19 +146,19 @@
<li>
<ul class="subnav">
- <li><span>Chapter3 - Newt Tool</span></li>
+ <li><span>Newt Tool</span></li>
<li class="toctree-l1 ">
- <a class="" href="chapter3/newt_ops/">Command structure</a>
+ <a class="" href="newt/newt_ops/">Command structure</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter3/newt_tool_reference/">Command list</a>
+ <a class="" href="newt/newt_tool_reference/">Command list</a>
</li>
@@ -165,89 +168,96 @@
<li>
<ul class="subnav">
- <li><span>Chapter4 - Newt OS</span></li>
+ <li><span>Mynewt OS</span></li>
+
+
+
+ <li class="toctree-l1 ">
+ <a class="" href="os/mynewt_os/">Overview</a>
+
+ </li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/mynewt_os/">Overview</a>
+ <a class="" href="os/context_switch/">Scheduler/Context Switching</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/context_switch/">Scheduler/Context Switching</a>
+ <a class="" href="os/time/">Time</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/time/">Time</a>
+ <a class="" href="os/task/">Tasks</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/task/">Tasks</a>
+ <a class="" href="os/event_queue/">Event Queues</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/event_queue/">Event Queues</a>
+ <a class="" href="os/semaphore/">Semaphores</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/semaphore/">Semaphores</a>
+ <a class="" href="os/mutex/">Mutexes</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/mutex/">Mutexes</a>
+ <a class="" href="os/memory_pool/">Memory Pools</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/memory_pool/">Memory Pools</a>
+ <a class="" href="os/heap/">Heap</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/heap/">Heap</a>
+ <a class="" href="os/mbufs/">Mbufs</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/mbufs/">Mbufs</a>
+ <a class="" href="os/sanity/">Sanity</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/sanity/">Sanity</a>
+ <a class="" href="os/callout/">Callout Functions</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter4/port_os/">Porting to other Platforms</a>
+ <a class="" href="os/port_os/">Porting to other Platforms</a>
</li>
@@ -262,35 +272,35 @@
<li class="toctree-l1 ">
- <a class="" href="chapter5/console/">Console</a>
+ <a class="" href="modules/console/">Console</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter5/shell/">Shell</a>
+ <a class="" href="modules/shell/">Shell</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter5/bootloader/">Bootloader</a>
+ <a class="" href="modules/bootloader/">Bootloader</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter5/filesystem/">File System</a>
+ <a class="" href="modules/filesystem/">File System</a>
</li>
<li class="toctree-l1 ">
- <a class="" href="chapter5/testutil/">Test Utilities</a>
+ <a class="" href="modules/testutil/">Test Utilities</a>
</li>
@@ -305,7 +315,7 @@
<li class="toctree-l1 ">
- <a class="" href="chapter6/dist/">Creating Packages</a>
+ <a class="" href="packaging/dist/">Creating Packages</a>
</li>
@@ -345,8 +355,7 @@
<div role="main">
<div class="section">
- <h1 id="_1"><img alt="ASF Incubator Project" src="./images/egg-logo.png" /><a class="headerlink" href="#_1" title="Permanent link">¶</a></h1>
-<hr />
+ <h2 id="asf-incubator-project"><a href="./images/egg-logo.png">ASF Incubator Project</a><a class="headerlink" href="#asf-incubator-project" title="Permanent link">¶</a></h2>
<h2 id="objective-of-mynewt">Objective of Mynewt<a class="headerlink" href="#objective-of-mynewt" title="Permanent link">¶</a></h2>
<p>Mynewt is an open source initiative to build a stack of modularized control, networking, and monitoring software for embedded devices like wearables, lightbulbs, locks, and doorbells. At the core is a real-time operating system that is designed to work on a variety of microcontrollers. The project includes the Newt tool to help you build and distribute embedded projects using Mynewt OS. The modular implementation allows the user the flexibility to mix and match hardware components and software stack depending on the feature and performance requirements of the particular application he or she has in mind.</p>
<p>The world of Mynewt, therefore, has three primary collaborative goals:</p>
@@ -415,22 +424,22 @@
<p>The chapter organization is outlined below. Each chapter will include one or more tutorials for hands-on experience with the material in each chapter. </p>
<ul>
<li>
-<p><a href="chapter1/newt_concepts/">Chapter 1: Get Started</a> introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.</p>
+<p><a href="get_started/newt_concepts/">Chapter 1: Get Started</a> introduces some key terms in this initiative and includes a tutorial for a quick project to show how to work with some of the products.</p>
</li>
<li>
-<p><a href="chapter2/vocabulary/">Chapter 2: Get Acclimated</a> delves deeper into the concepts crucial to the software development effort. </p>
+<p><a href="get_acclimated/vocabulary/">Chapter 2: Get Acclimated</a> delves deeper into the concepts crucial to the software development effort. </p>
</li>
<li>
-<p><a href="chapter3/newt_ops/">Chapter 3: Newt Tool Reference</a> describes the command structure and details all the available commands to help you with your project. </p>
+<p><a href="newt/newt_ops/">Chapter 3: Newt Tool Reference</a> describes the command structure and details all the available commands to help you with your project. </p>
</li>
<li>
-<p><a href="chapter4/mynewt_os/">Chapter 4: Newt OS</a> provides an overview of the features available and how to customize for your hardware and software application.</p>
+<p><a href="os/mynewt_os/">Chapter 4: Newt OS</a> provides an overview of the features available and how to customize for your hardware and software application.</p>
</li>
<li>
-<p><a href="chapter5/console/">Chapter 5: Modules</a> lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.</p>
+<p><a href="modules/console/">Chapter 5: Modules</a> lays out all the available modules such as HAL (Hardware Abstraction Layer), console, file system, networking stacks, and other middleware components.</p>
</li>
<li>
-<p><a href="chapter6/dist/">Chapter 6: Creating packages for distribution</a> delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.</p>
+<p><a href="packaging/dist/">Chapter 6: Creating packages for distribution</a> delineates the process of creating complete packages to load on your embedded device to get it up, connected, and ready for remote management.</p>
</li>
</ul>
<h3 id="contributing-to-documentation">Contributing to Documentation<a class="headerlink" href="#contributing-to-documentation" title="Permanent link">¶</a></h3>
@@ -440,7 +449,7 @@
<li><a href="http://25.io/mou/">Mou</a> for Mac</li>
<li><a href="http://alternativeto.net/software/mou/?platform=windows">Something like Mou</a> for Windows</li>
</ul>
-<p>Click on the tutorial <a href="chapter1/how_to_edit_docs/">How to edit docs</a> under "Get Started" to learn how to edit a sample file <a href="chapter1/try_markdown/">try_markdown.md</a> on Mynewt's documentation git repository.</p>
+<p>Click on the tutorial <a href="get_started/how_to_edit_docs/">How to edit docs</a> under "Get Started" to learn how to edit a sample file <a href="get_started/try_markdown/">try_markdown.md</a> on Mynewt's documentation git repository.</p>
<p>The static html content is generated and maintained in the asf-site branch in the documentation repository. Currently, the static html files are generated manually once a day. This will be automated in the future.</p>
<p>If you wish, you may preview the changes you have made on your desktop by installing MkDocs and starting up its built-in webserver as described in <a href="http://www.mkdocs.org">MkDocs</a>. This step is optional but described in the tutorial.</p>
@@ -450,7 +459,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="chapter1/newt_concepts/" class="btn btn-neutral float-right" title="Newt Concepts"/>Next <span class="icon icon-circle-arrow-right"></span></a>
+ <a href="get_started/newt_concepts/" class="btn btn-neutral float-right" title="Newt Concepts"/>Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
@@ -478,7 +487,7 @@
- <span style="margin-left: 15px"><a href="chapter1/newt_concepts/" style="color: #fcfcfc">Next »</a></span>
+ <span style="margin-left: 15px"><a href="get_started/newt_concepts/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
@@ -488,5 +497,5 @@
<!--
MkDocs version : 0.14.0
-Build Date UTC : 2015-11-26 00:20:10.466335
+Build Date UTC : 2015-12-18 19:41:18.331638
-->