You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by we...@apache.org on 2015/10/29 02:05:12 UTC

incubator-mynewt-site git commit: site skeleton

Repository: incubator-mynewt-site
Updated Branches:
  refs/heads/asf-site 6fd10fd6b -> 8569aabf0


site skeleton


Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/8569aabf
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/8569aabf
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/8569aabf

Branch: refs/heads/asf-site
Commit: 8569aabf00c52ec100a1adb5475ceaf0d1319015
Parents: 6fd10fd
Author: aditihilbert <ad...@runtime.io>
Authored: Wed Oct 28 18:03:06 2015 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Wed Oct 28 18:03:06 2015 -0700

----------------------------------------------------------------------
 asf_logo_wide.gif | Bin 0 -> 7051 bytes
 egg-logo.png      | Bin 0 -> 8626 bytes
 index.html        |  52 +++++++++++++++-
 intro.html        | 160 +++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 209 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8569aabf/asf_logo_wide.gif
----------------------------------------------------------------------
diff --git a/asf_logo_wide.gif b/asf_logo_wide.gif
new file mode 100644
index 0000000..fc287a8
Binary files /dev/null and b/asf_logo_wide.gif differ

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8569aabf/egg-logo.png
----------------------------------------------------------------------
diff --git a/egg-logo.png b/egg-logo.png
new file mode 100644
index 0000000..c04e70d
Binary files /dev/null and b/egg-logo.png differ

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8569aabf/index.html
----------------------------------------------------------------------
diff --git a/index.html b/index.html
index 81acea1..3bf18c2 100644
--- a/index.html
+++ b/index.html
@@ -1,9 +1,40 @@
 <html> 
  <head>
-  <title>Apache Mynewt</title>
+   <title>Apache Mynewt</title>
+   <style type="text/css">
+  body {
+    padding-left: 11em;}
+  ul.navbar {
+    position: absolute;
+    top: 14em;
+    left: 1em;
+    width: 9em }
+   </style>
  </head>
+ 
  <body>
-  <h1>Apache Mynewt</h1>
+ 
+  <div class="container">
+  <div class="row">
+  <div class="span12">
+<a href="http://incubator.apache.org/"><img src="egg-logo.png" alt="Apache Incubator" border="0"/></a>
+</div>
+</div>
+
+
+</menu>  <h1>Apache Mynewt</h1>
+
+<!-- Site navigation menu -->
+
+<ul class="navbar">
+  <li><a href="index.html">Welcome</a>
+  <li><a href="intro.html">Overview</a>
+  <li><a href="https://issues.apache.org/jira/browse/MYNEWT/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel">Issue Tracking</a>
+  <li><a href="links.html">Documentation</a>
+</ul>
+
+<!-- Main content -->
+<h2>Introduction</h2>
   <p>
   This is a placeholder for the Apache Mynewt project.
   </p> 
@@ -11,5 +42,20 @@
   In the meanwhile, if you're interested in contributing - join the dev@mynewt.incubator.apache.org
   mailing list, and say hi! 
   </p>
+
+
+<h2> Links </h2>
+
+<li><a href="https://wiki.apache.org/incubator/MynewtProposal"> Project Proposal</a>
+
+
+<h2> Mailing Lists </h2>
+
+<li> dev@mynewt.incubator.apache.org (contributers and users)
+
+<li> commit@mynewt.incubator.apache.org (contributers to code or documentation)
+
+<li> notifications@mynewt.incubator.apache.org (autogenerated mail except commits e.g. JIRA notifications)
+
  </body>
-</html>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/8569aabf/intro.html
----------------------------------------------------------------------
diff --git a/intro.html b/intro.html
new file mode 100644
index 0000000..5deab4c
--- /dev/null
+++ b/intro.html
@@ -0,0 +1,160 @@
+<!doctype html>
+<html>
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
+<style>
+*{margin:0;padding:0;}
+body {
+	font:13.34px helvetica,arial,freesans,clean,sans-serif;
+	color:black;
+	line-height:1.4em;
+	background-color: #F8F8F8;
+	padding: 0.7em;
+}
+p {
+	margin:1em 0;
+	line-height:1.5em;
+}
+table {
+	font-size:inherit;
+	font:100%;
+	margin:1em;
+}
+table th{border-bottom:1px solid #bbb;padding:.2em 1em;}
+table td{border-bottom:1px solid #ddd;padding:.2em 1em;}
+input[type=text],input[type=password],input[type=image],textarea{font:99% helvetica,arial,freesans,sans-serif;}
+select,option{padding:0 .25em;}
+optgroup{margin-top:.5em;}
+pre,code{font:12px Monaco,"Courier New","DejaVu Sans Mono","Bitstream Vera Sans Mono",monospace;}
+pre {
+	margin:1em 0;
+	font-size:12px;
+	background-color:#eee;
+	border:1px solid #ddd;
+	padding:5px;
+	line-height:1.5em;
+	color:#444;
+	overflow:auto;
+	-webkit-box-shadow:rgba(0,0,0,0.07) 0 1px 2px inset;
+	-webkit-border-radius:3px;
+	-moz-border-radius:3px;border-radius:3px;
+}
+pre code {
+	padding:0;
+	font-size:12px;
+	background-color:#eee;
+	border:none;
+}
+code {
+	font-size:12px;
+	background-color:#f8f8ff;
+	color:#444;
+	padding:0 .2em;
+	border:1px solid #dedede;
+}
+img{border:0;max-width:100%;}
+abbr{border-bottom:none;}
+a{color:#4183c4;text-decoration:none;}
+a:hover{text-decoration:underline;}
+a code,a:link code,a:visited code{color:#4183c4;}
+h2,h3{margin:1em 0;}
+h1,h2,h3,h4,h5,h6{border:0;}
+h1{font-size:170%;border-top:4px solid #aaa;padding-top:.5em;margin-top:1.5em;}
+h1:first-child{margin-top:0;padding-top:.25em;border-top:none;}
+h2{font-size:150%;margin-top:1.5em;border-top:4px solid #e0e0e0;padding-top:.5em;}
+h3{margin-top:1em;}
+hr{border:1px solid #ddd;}
+ul{margin:1em 0 1em 2em;}
+ol{margin:1em 0 1em 2em;}
+ul li,ol li{margin-top:.5em;margin-bottom:.5em;}
+ul ul,ul ol,ol ol,ol ul{margin-top:0;margin-bottom:0;}
+blockquote{margin:1em 0;border-left:5px solid #ddd;padding-left:.6em;color:#555;}
+dt{font-weight:bold;margin-left:1em;}
+dd{margin-left:2em;margin-bottom:1em;}
+sup {
+    font-size: 0.83em;
+    vertical-align: super;
+    line-height: 0;
+}
+* {
+	-webkit-print-color-adjust: exact;
+}
+@media screen and (min-width: 914px) {
+    body {
+        width: 854px;
+        margin:0 auto;
+    }
+}
+@media print {
+	table, pre {
+		page-break-inside: avoid;
+	}
+	pre {
+		word-wrap: break-word;
+	}
+}
+</style>
+<title>Introduction to Mynewt - test</title>
+
+</head>
+<body>
+<h1>Introduction to Mynewt - test</h1>
+
+<p>We want to make it very simple for an application developer to develop and release application programs on an embedded device of their choice. With that in mind, we offer a complete suite of open-source software ranging from an operating system to network protocol stacks. We offer the user of our wares the flexibility to choose hardware component(s) and easily build a software platform for it with desired features and performance.</p>
+
+<p>We invite you to join us in our efforts to develop the ecosystem of firmware, software, and tools needed to offer the higher level of abstraction to various developers to enable them to be more productive and to decrease the time to market their applications on the embedded devices of their choosing.</p>
+
+<h2>Basic components in the ecosystem</h2>
+
+<ul>
+<li><p>NewtOS is an open-source RTOS (Real Time Operating System) that is not tied to any particular hardware but can be tuned to the hardware component mix of the user's choosing. It has support for multitasking, synchronization of tasks, scheduling and buffering of operations, memory management,file systems, networking, security, power management, and other advanced features. Naturally, it involves several packages such as the Core RTOS, a flash file system, utility functions, a variety of board support packages, packages of microcontrollers etc.</p></li>
+<li><p>Network protocol stacks such as Bluetooth Low Energy, and more</p></li>
+<li><p>Newt Tool helps you mix the specific packages for the combination of hardware and low-level embedded architecture features of the user's choice and generate the corresponding run-time image based on the NewtOS. It provides the infrastructure to manage and build for different CPU architectures, memory units, board support packages etc., allowing a user to formulate the contents according to the low-level features needed by his or her project.</p></li>
+</ul>
+
+
+<h2>Terminology</h2>
+
+<p>In the mynewt lifecycle, a project grows in a nest. A nest may house multiple projects. The nest is, therefore, a repository where various component packages for one or more projects reside. Each package is an egg, naturally. However, an egg may consist of other eggs!</p>
+
+<p>A nest can be given any name. You will see a nest named "tadpole" in mynewt. It contains all the core libraries of the operating system for distribution. Each of these directories contain one or more eggs where an egg is a basic unit of implementation of any aspect of the RTOS.</p>
+
+<ul>
+<li>libs/os: The core RTOS which ports to all supported chip platforms.</li>
+<li>hw/hal: The hardware abstraction layer (HAL) API definitions that all BSP and MCU implementations must support</li>
+<li>hw/mcu/native: A MCU implementation for the native platform</li>
+<li>hw/bsp/native: A BSP implementation for the native platform</li>
+<li>compiler/native: The definition of compiler support for the native platform.</li>
+</ul>
+
+
+<p>Each of the above directories contain one or more eggs where an egg is a basic unit of implementation of any aspect of the RTOS. For example, the libs/os directory holds eggs such as the bootloader, flash file system, the kernel for process/thread/memory management, tools for testing etc. The hw/hal directory holds an egg that provides abstraction for physical hardware components such as GPIO (general purpose input/output), network adapters, timers, and universal asynchronous receiver-transmitters (UARTs). All these physical interfaces are defined in various header files in hw/hal, and are designed to make device driver specification simpler.</p>
+
+<p>You can see another nest in the mynewt ecosystem called the "larva". It was spawned from the "tadpole" nest using the newt tool. Spawning is easy - <code>$ newt create nest &lt;your_nest_name&gt;</code>. "larva" is the developer's test repository containing all sorts of eggs being incubated, including ones to enhance the core operating system which should eventually make their way into the "tadpole" nest. There is a <code>hatch_tadpole</code> script to update the "tadpole" nest when the core OS related eggs in "larva" are ready.</p>
+
+<p>There is a third nest named "newt" that contains all the eggs needed to support the build and release process of mynewt software.</p>
+
+<p>There will also be pre-built nests for certain common hardware devices to enable a user to quickly get started with a project.</p>
+
+<h2>A Mynewt contributor</h2>
+
+<p>A contributor can choose to work on any area(s) of the Mynewt endeavor that appeals to him or her. Hence, you can work on one or more eggs or an entire nest. You can create your own nest (master) or create a branch in an existing nest. For now, Runtime contributors will review any new areas of support that you may wish to introduce e.g. a new board support package (BSP) or a new network protocol.</p>
+
+<p>A contributer role necessarily implies he or she is a Mynewt user (see below) of some or all of the products developed.</p>
+
+<h2>A Mynewt user</h2>
+
+<p>An application developer is interested only in using software available in this ecosystem to build a top level build artifact. He or she may either:</p>
+
+<ul>
+<li>Use a pre-built nest, or</li>
+<li>Spawn a new nest using the newt tool for a target where a target is a custom combination of supported hardware components</li>
+</ul>
+
+
+<p>In either case, the user would use the newt tool to create and set the target in the chosen nest. The newt tool would then be used to build out the target profile which would determine which eggs to choose. Finally, the user would use the newt tool to generate a run-time image that can be run on the device.</p>
+
+
+</body>
+</html>
\ No newline at end of file