http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/json/json_encode_object_key/index.html ---------------------------------------------------------------------- diff --git a/os/modules/json/json_encode_object_key/index.html b/os/modules/json/json_encode_object_key/index.html index 19b5a1f..b53312f 100644 --- a/os/modules/json/json_encode_object_key/index.html +++ b/os/modules/json/json_encode_object_key/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/json/json_encode_object_start/index.html ---------------------------------------------------------------------- diff --git a/os/modules/json/json_encode_object_start/index.html b/os/modules/json/json_encode_object_start/index.html index 6b7ed15..222b5b6 100644 --- a/os/modules/json/json_encode_object_start/index.html +++ b/os/modules/json/json_encode_object_start/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/json/json_encode_value/index.html ---------------------------------------------------------------------- diff --git a/os/modules/json/json_encode_value/index.html b/os/modules/json/json_encode_value/index.html index de5c7c5..d8d2524 100644 --- a/os/modules/json/json_encode_value/index.html +++ b/os/modules/json/json_encode_value/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/json/json_internal_read_object/index.html ---------------------------------------------------------------------- diff --git a/os/modules/json/json_internal_read_object/index.html b/os/modules/json/json_internal_read_object/index.html index e6ed0c5..eb18cd4 100644 --- a/os/modules/json/json_internal_read_object/index.html +++ b/os/modules/json/json_internal_read_object/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/json/json_read_array/index.html ---------------------------------------------------------------------- diff --git a/os/modules/json/json_read_array/index.html b/os/modules/json/json_read_array/index.html index 6e994ad..1e3c861 100644 --- a/os/modules/json/json_read_array/index.html +++ b/os/modules/json/json_read_array/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/json/json_read_object/index.html ---------------------------------------------------------------------- diff --git a/os/modules/json/json_read_object/index.html b/os/modules/json/json_read_object/index.html index 63c4c74..7682b5d 100644 --- a/os/modules/json/json_read_object/index.html +++ b/os/modules/json/json_read_object/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/json/json_target_address/index.html ---------------------------------------------------------------------- diff --git a/os/modules/json/json_target_address/index.html b/os/modules/json/json_target_address/index.html index 9076654..b6220eb 100644 --- a/os/modules/json/json_target_address/index.html +++ b/os/modules/json/json_target_address/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/shell/shell/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell/index.html b/os/modules/shell/shell/index.html index dcfa675..6161ca7 100644 --- a/os/modules/shell/shell/index.html +++ b/os/modules/shell/shell/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/shell/shell_cmd_register/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell_cmd_register/index.html b/os/modules/shell/shell_cmd_register/index.html index 5e7ec94..bd29a8a 100644 --- a/os/modules/shell/shell_cmd_register/index.html +++ b/os/modules/shell/shell_cmd_register/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/shell/shell_nlip_input_register/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell_nlip_input_register/index.html b/os/modules/shell/shell_nlip_input_register/index.html index 1540b5c..0643190 100644 --- a/os/modules/shell/shell_nlip_input_register/index.html +++ b/os/modules/shell/shell_nlip_input_register/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/shell/shell_nlip_output/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell_nlip_output/index.html b/os/modules/shell/shell_nlip_output/index.html index 8861a0a..55f25e4 100644 --- a/os/modules/shell/shell_nlip_output/index.html +++ b/os/modules/shell/shell_nlip_output/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/shell/shell_task_init/index.html ---------------------------------------------------------------------- diff --git a/os/modules/shell/shell_task_init/index.html b/os/modules/shell/shell_task_init/index.html index cf9f179..b865c22 100644 --- a/os/modules/shell/shell_task_init/index.html +++ b/os/modules/shell/shell_task_init/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/testutil/test_assert/index.html ---------------------------------------------------------------------- diff --git a/os/modules/testutil/test_assert/index.html b/os/modules/testutil/test_assert/index.html index d83fb61..45eed79 100644 --- a/os/modules/testutil/test_assert/index.html +++ b/os/modules/testutil/test_assert/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/testutil/test_case/index.html ---------------------------------------------------------------------- diff --git a/os/modules/testutil/test_case/index.html b/os/modules/testutil/test_case/index.html index 61d9f94..a3327d6 100644 --- a/os/modules/testutil/test_case/index.html +++ b/os/modules/testutil/test_case/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/testutil/test_decl/index.html ---------------------------------------------------------------------- diff --git a/os/modules/testutil/test_decl/index.html b/os/modules/testutil/test_decl/index.html index ea32d41..69e7e27 100644 --- a/os/modules/testutil/test_decl/index.html +++ b/os/modules/testutil/test_decl/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/testutil/test_pass/index.html ---------------------------------------------------------------------- diff --git a/os/modules/testutil/test_pass/index.html b/os/modules/testutil/test_pass/index.html index 122057d..61da51b 100644 --- a/os/modules/testutil/test_pass/index.html +++ b/os/modules/testutil/test_pass/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/testutil/test_suite/index.html ---------------------------------------------------------------------- diff --git a/os/modules/testutil/test_suite/index.html b/os/modules/testutil/test_suite/index.html index 999b542..9c4adec 100644 --- a/os/modules/testutil/test_suite/index.html +++ b/os/modules/testutil/test_suite/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/testutil/testutil/index.html ---------------------------------------------------------------------- diff --git a/os/modules/testutil/testutil/index.html b/os/modules/testutil/testutil/index.html index e1bb97f..0ba7d9c 100644 --- a/os/modules/testutil/testutil/index.html +++ b/os/modules/testutil/testutil/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/testutil/tu_init/index.html ---------------------------------------------------------------------- diff --git a/os/modules/testutil/tu_init/index.html b/os/modules/testutil/tu_init/index.html index cbce181..5244a5b 100644 --- a/os/modules/testutil/tu_init/index.html +++ b/os/modules/testutil/tu_init/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/modules/testutil/tu_restart/index.html ---------------------------------------------------------------------- diff --git a/os/modules/testutil/tu_restart/index.html b/os/modules/testutil/tu_restart/index.html index ac7c890..b755c82 100644 --- a/os/modules/testutil/tu_restart/index.html +++ b/os/modules/testutil/tu_restart/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../../get_started/get_started/">Get Started</a></li> </li> @@ -225,9 +223,7 @@ - <li><a href=" - ../../../tutorials/olimex/ -">Tutorials</a> + <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/tutorials/STM32F303/index.html ---------------------------------------------------------------------- diff --git a/os/tutorials/STM32F303/index.html b/os/tutorials/STM32F303/index.html index bc4d1c4..51baaa6 100644 --- a/os/tutorials/STM32F303/index.html +++ b/os/tutorials/STM32F303/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../get_started/get_started/">Get Started</a></li> </li> @@ -225,18 +223,18 @@ - <li><a href=" - ../olimex/ -">Tutorials</a> + <li ><a href="../tutorials/">Tutorials</a></li> <ul class="current-toc"> + + <li> - <a href="../olimex/">Blinky on Olimex</a> + <a href="../arduino_zero/">Blinky on Arduino Zero</a> </li> @@ -245,8 +243,8 @@ - <li class="active"> - Blinky on STM32F303 + <li> + <a href="../olimex/">Blinky on Olimex</a> </li> @@ -255,8 +253,8 @@ - <li> - <a href="../nRF52/">Blinky on nRF52</a> + <li class="active"> + Blinky on STM32F303 </li> @@ -266,7 +264,7 @@ <li> - <a href="../arduino_zero/">Blinky on Arduino Zero</a> + <a href="../nRF52/">Blinky on nRF52</a> </li> @@ -276,7 +274,7 @@ <li> - <a href="../unit_test/">Unit Testing a Package</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> @@ -286,7 +284,7 @@ <li> - <a href="../air_quality_sensor/">Adding an air-quality sensor</a> + <a href="../air_quality_sensor/">Air-quality Sensor project</a> </li> @@ -439,7 +437,7 @@ - <li>» <a href="../olimex/">Tutorials</a></li> + <li>» <a href="../tutorials/">Tutorials</a></li> @@ -452,217 +450,169 @@ </div> </div> - <h2 id="blinky-on-stm32f303-board">Blinky on STM32F303 board<a class="headerlink" href="#blinky-on-stm32f303-board" title="Permanent link">¶</a></h2> + <h2 id="blinky-on-stm32f303-discovery-board">Blinky on STM32F303 Discovery board<a class="headerlink" href="#blinky-on-stm32f303-discovery-board" title="Permanent link">¶</a></h2> +<p><br></p> <h3 id="objective">Objective<a class="headerlink" href="#objective" title="Permanent link">¶</a></h3> -<p>Download a generic firmware skeleton ("bootstrap image") that applies to any hardware and then throw in additional applicable pkgs to generate a build for a specific board, namely the STM32F303VC MCU from STMicroelectronics.</p> -<h4 id="hardware-needed">Hardware needed<a class="headerlink" href="#hardware-needed" title="Permanent link">¶</a></h4> +<p>Create a project with a simple app that blinks an LED on the stmf303 +discovery board. Download the application to the target and watch it blink.</p> +<p><br></p> +<h3 id="what-you-need">What you need<a class="headerlink" href="#what-you-need" title="Permanent link">¶</a></h3> <ul> <li>Discovery kit with STM32F303VC MCU</li> -<li>Laptop running Mac OS</li> +<li>Laptop running Mac OSX. </li> +<li>It is assumed you have already installed newt tool. </li> +<li>It is assumed you already installed native tools as described <a href="../../get_started/native_tools/">here</a></li> </ul> -<h4 id="step-by-step-instructions-to-build-image">Step by Step Instructions to build image<a class="headerlink" href="#step-by-step-instructions-to-build-image" title="Permanent link">¶</a></h4> -<ul> -<li>The first step is to download the generic skeleton of the project. The pkgs constituting the skeleton are not hardware architecture specific. The skeleton is maintained as an app in a separate repository on Apache. You know it is an app because there is an app.yml file. </li> -</ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">app</span> <span style="color: #000000">create</span> <span style="color: #000000">test_project</span> - <span style="color: #000000">Downloading</span> <span style="color: #000000">app</span> <span style="color: #000000">skeleton</span> <span style="color: #000000">from</span> <span style="color: #000000">https</span>:<span style="color: #177500">//git-wip-us.apache.org/repos/asf/incubator-mynewt-tadpole.git... ok!</span> - <span style="color: #000000">app</span> <span style="color: #000000">test_project</span> <span style="color: #000000">successfully</span> <span style="color: #000000">created</span> <span style="color: #000000">in</span> <span style="color: #000000">~/dev/go/test_project</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev</span>]<span style="color: #000000">$</span> <span style="color: #000000">cd</span> <span style="color: #000000">test_project/</span> - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">ls</span> - <span style="color: #000000">README</span>.<span style="color: #000000">md</span> <span style="color: #000000">compiler</span> <span style="color: #000000">hw</span> <span style="color: #000000">libs</span> <span style="color: #000000">app</span>.<span style="color: #000000">yml</span> +<p>Also, we assume that you're familiar with UNIX shells. Let's gets started!</p> +<p><br></p> +<h3 id="create-a-project">Create a project<a class="headerlink" href="#create-a-project" title="Permanent link">¶</a></h3> +<p>Create a new project to hold your work. For a deeper understanding, you can read about project creation in +<a href="../../get_started/project_create/">Get Started -- Creating Your First Project</a> +or just follow the commands below.</p> +<p>If you've already created a project from another tutorial, you can re-use +that project.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ mkdir ~/dev +$ cd ~/dev +$ newt new myproj +Downloading project skeleton from apache/incubator-mynewt-blinky... +Installing skeleton in myproj... +Project myproj successfully created. + +$ cd myproj </pre></div> -<ul> -<li>Next, the pkg-list named larva is added from the app (also named larva) from another repository on Apache. This step simply downloads the pkg-list description file and does not actually install the pkgs that constitute the pkg-list. The pkg-list description file (<code>pkg-list.yml</code>) will be used to check dependencies during the pkg install to ensure completeness. It serves as a reference for all the pkgs in the pkg-list that one can choose from and install.</li> -</ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">app</span> <span style="color: #000000">add-pkg-list</span> <span style="color: #000000">larva</span> <span style="color: #000000">https</span>:<span style="color: #177500">//git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git</span> - <span style="color: #000000">Downloading</span> <span style="color: #000000">pkg-list</span>.<span style="color: #000000">yml</span> <span style="color: #000000">from</span> <span style="color: #000000">https</span>:<span style="color: #177500">//git-wip-us.apache.org/repos/asf/incubator-mynewt-larva.git/master... ok!</span> - <span style="color: #000000">Verifying</span> <span style="color: #000000">pkg-list</span>.<span style="color: #000000">yml</span> <span style="color: #000000">format</span>... - <span style="color: #000000">ok!</span> - <span style="color: #000000">pkg-list</span> <span style="color: #000000">larva</span> <span style="color: #000000">successfully</span> <span style="color: #000000">installed</span> <span style="color: #000000">to</span> <span style="color: #000000">app</span>. +<p><strong>Note:</strong> Don't forget to change into the <code>myproj</code> directory.</p> +<p><br></p> +<h3 id="import-external-stm32f3-library-support">Import External STM32F3 Library support<a class="headerlink" href="#import-external-stm32f3-library-support" title="Permanent link">¶</a></h3> +<p>The STM32F303 support for Mynewt lives in an external repository. It's +necessary to add another repository to the project. To do this, +edit the file <code>project.yml</code> in the root directory of your project <code>myproj</code></p> +<p>This requires two changes to this file.</p> +<ol> +<li>You must define the properties of the external repository that you want +to add</li> +<li>You must include the repository in your project.</li> +</ol> +<p>Edit the file <code>project.yml</code> with your favorite editor and add the +following repository details in the file (after the core +repository). This gives newt the information to contact the repository +and extract its contents. In this case, the repository is on github in +the <code>runtimeinc</code> collection. Its name is <code>mynewt-stm32f3</code> and we will accept +any version up to the latest. You can look at the contents <a href="https://github.com/runtimeinc/mynewt_stm32f3";>here</a>.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">repository.mynewt_stm32f3: + type: github + vers: 0-latest + user: runtimeinc + repo: mynewt_stm32f3 </pre></div> -<ul> -<li>The next step is to install relevant pkgs from the larva app from git server on Apache. The instructions assume that you know what application or project you are interested in (the blinky application, in this case), what hardware you are using (STM32F3DISCOVERY board, in this case) and hence, what board support package you need. </li> -</ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">pkg</span> <span style="color: #000000">install</span> <span style="color: #000000">project/blinky</span> - <span style="color: #000000">Downloading</span> <span style="color: #000000">larva</span> <span style="color: #000000">from</span> <span style="color: #000000">https</span>:<span style="color: #177500">//git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!</span> - <span style="color: #000000">Installing</span> <span style="color: #000000">project/blinky</span> - <span style="color: #000000">Installing</span> <span style="color: #000000">libs/console/full</span> - <span style="color: #000000">Installing</span> <span style="color: #000000">libs/shell</span> - <span style="color: #000000">Installation</span> <span style="color: #000000">was</span> <span style="color: #000000">a</span> <span style="color: #000000">success!</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">pkg</span> <span style="color: #000000">install</span> <span style="color: #000000">hw/bsp/stm32f3discovery</span> - <span style="color: #000000">Downloading</span> <span style="color: #000000">larva</span> <span style="color: #000000">from</span> <span style="color: #000000">https</span>:<span style="color: #177500">//git-wip-us.apache.org/repos/asf/incubator-mynewt-larva/master... ok!</span> - <span style="color: #000000">Installing</span> <span style="color: #000000">hw/bsp/stm32f3discovery</span> - <span style="color: #000000">Installing</span> <span style="color: #000000">hw/mcu/stm/stm32f3xx</span> - <span style="color: #000000">Installing</span> <span style="color: #000000">libs/cmsis-core</span> - <span style="color: #000000">Installing</span> <span style="color: #000000">compiler/arm-none-eabi-m4</span> - <span style="color: #000000">Installation</span> <span style="color: #000000">was</span> <span style="color: #000000">a</span> <span style="color: #000000">success!</span> +<p><br></p> +<p>In the same file, add the following highlighted line to the +<code>project.repositories</code> variable. This tells newt to download the + repository contents into your project. </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">project.repositories: + - apache-mynewt-core +<span style="background-color: #ffffcc"> - mynewt_stm32f3 +</span></pre></div> + + +<p><br></p> +<h3 id="install-dependencies">Install dependencies<a class="headerlink" href="#install-dependencies" title="Permanent link">¶</a></h3> +<p>Now you can install this into the project using:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt install -v +Downloading repository description for apache-mynewt-core... success! +... +apache-mynewt-core successfully installed version 0.7.9-none +... +Downloading repository description for mynewt_stm32f3... success! +Downloading repository mynewt_stm32f3 +... +Resolving deltas: 100% (65/65), done. +Checking connectivity... done. +mynewt_stm32f3 successfully installed version 0.0.0-none </pre></div> -<ul> -<li>It's time to create a targets for the project and define the target attributes. STM32F3 BSP expects bootloader, so create targets for both blinky and bootloader.</li> -</ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">create</span> <span style="color: #000000">blink_f3disc</span> - <span style="color: #000000">Creating</span> <span style="color: #000000">target</span> <span style="color: #000000">blink_f3disc</span> - <span style="color: #000000">Target</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">created!</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">set</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">project=blinky</span> - <span style="color: #000000">Target</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">set</span> <span style="color: #000000">project</span> <span style="color: #000000">to</span> <span style="color: #000000">blinky</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">set</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">bsp=hw/bsp/stm32f3discovery</span> - <span style="color: #000000">Target</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">set</span> <span style="color: #000000">bsp</span> <span style="color: #000000">to</span> <span style="color: #000000">hw/bsp/stm32f3discovery</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">set</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">compiler_def=debug</span> - <span style="color: #000000">Target</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">set</span> <span style="color: #000000">compiler_def</span> <span style="color: #000000">to</span> <span style="color: #000000">debug</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">set</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">compiler=arm-none-eabi-m4</span> - <span style="color: #000000">Target</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">set</span> <span style="color: #000000">compiler</span> <span style="color: #000000">to</span> <span style="color: #000000">arm-none-eabi-m4</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">set</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">arch=cortex_m4</span> - <span style="color: #000000">Target</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">set</span> <span style="color: #000000">arch</span> <span style="color: #000000">to</span> <span style="color: #000000">cortex_m4</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">create</span> <span style="color: #000000">boot_f3disc</span> - <span style="color: #000000">Creating</span> <span style="color: #000000">target</span> <span style="color: #000000">boot_f3disc</span> - <span style="color: #000000">Target</span> <span style="color: #000000">boot_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">created!</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">set</span> <span style="color: #000000">boot_f3disc</span> <span style="color: #000000">project=boot</span> - <span style="color: #000000">Target</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">set</span> <span style="color: #000000">project</span> <span style="color: #000000">to</span> <span style="color: #000000">blinky</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">set</span> <span style="color: #000000">boot_f3disc</span> <span style="color: #000000">bsp=hw/bsp/stm32f3discovery</span> - <span style="color: #000000">Target</span> <span style="color: #000000">boot_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">set</span> <span style="color: #000000">bsp</span> <span style="color: #000000">to</span> <span style="color: #000000">hw/bsp/stm32f3discovery</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">set</span> <span style="color: #000000">boot_f3disc</span> <span style="color: #000000">compiler_def=optimized</span> - <span style="color: #000000">Target</span> <span style="color: #000000">boot_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">set</span> <span style="color: #000000">compiler_def</span> <span style="color: #000000">to</span> <span style="color: #000000">debug</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">set</span> <span style="color: #000000">boot_f3disc</span> <span style="color: #000000">compiler=arm-none-eabi-m4</span> - <span style="color: #000000">Target</span> <span style="color: #000000">boot_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">set</span> <span style="color: #000000">compiler</span> <span style="color: #000000">to</span> <span style="color: #000000">arm-none-eabi-m4</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">set</span> <span style="color: #000000">boot_f3disc</span> <span style="color: #000000">arch=cortex_m4</span> - <span style="color: #000000">Target</span> <span style="color: #000000">boot_f3disc</span> <span style="color: #000000">successfully</span> <span style="color: #000000">set</span> <span style="color: #000000">arch</span> <span style="color: #000000">to</span> <span style="color: #000000">cortex_m4</span> +<p><br></p> +<h3 id="create-targets">Create targets<a class="headerlink" href="#create-targets" title="Permanent link">¶</a></h3> +<p>Create two targets to build using the stmf3 board support package and the +app blinky example from mynewt. The output of these commands are not +shown here for brevity. </p> +<p>The first target is the application image itself. The second +target is the bootloader which allows you to upgrade your mynewt +applications. </p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt target create stmf3_blinky +$ newt target set stmf3_blinky build_profile=optimized +$ newt target set stmf3_blinky bsp=@mynewt_stm32f3/hw/bsp/stm32f3discovery +$ newt target set stmf3_blinky app=apps/blinky + +$ newt target create stmf3_boot +$ newt target set stmf3_boot app=@apache-mynewt-core/apps/boot +$ newt target set stmf3_boot bsp=@mynewt_stm32f3/hw/bsp/stm32f3discovery +$ newt target set stmf3_boot build_profile=optimized + +$ newt target show + +targets/stmf3_blinky + app=apps/blinky + bsp=@mynewt_stm32f3/hw/bsp/stm32f3discovery + build_profile=optimized +targets/stmf3_boot + app=apps/boot + bsp=@mynewt_stm32f3/hw/bsp/stm32f3discovery + build_profile=optimized +</pre></div> - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">show</span> <span style="color: #000000">blink_f3disc</span> - <span style="color: #000000">blink_f3disc</span> - <span style="color: #000000">arch=cortex_m4</span> - <span style="color: #000000">bsp=hw/bsp/stm32f3discovery</span> - <span style="color: #000000">compiler=arm-none-eabi-m4</span> - <span style="color: #000000">compiler_def=debug</span> - <span style="color: #000000">name=blink_f3disc</span> - <span style="color: #000000">project=blinky</span> - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">show</span> <span style="color: #000000">boot_f3disc</span> - <span style="color: #000000">boot_f3disc</span> - <span style="color: #000000">arch=cortex_m4</span> - <span style="color: #000000">bsp=hw/bsp/stm32f3discovery</span> - <span style="color: #000000">compiler=arm-none-eabi-m4</span> - <span style="color: #000000">compiler_def=debug</span> - <span style="color: #000000">name=blink_f3disc</span> - <span style="color: #000000">project=boot</span> +<p><br></p> +<h3 id="build-the-images">Build the images<a class="headerlink" href="#build-the-images" title="Permanent link">¶</a></h3> +<p>To build the images, use the <code>newt build</code> command below.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt build stmf3_blinky + ... +Archiving stm32f3discovery.a +Linking blinky.elf +App successfully built: ~/dev/myproj/bin/stmf3_blinky/apps/blinky/blinky.elf + +$ newt build stmf3_boot +Compiling log_shell.c +Archiving log.a +Linking boot.elf +App successfully built: ~/dev/myproj/bin/stmf3_boot/apps/boot/boot.elf </pre></div> -<ul> -<li>STM32F3 blinky project is too large to operate with newlib libc. You need to modify project/blinky/pkg.yml, and switch over to using baselibc.</li> -</ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">cat</span> <span style="color: #000000">project/blinky/pkg</span>.<span style="color: #000000">yml</span> - <span style="color: #000000">#</span> - <span style="color: #633820"># Licensed to the Apache Software Foundation (ASF) under one</span> - <span style="color: #633820"># or more contributor license agreements. See the NOTICE file</span> - <span style="color: #633820"># distributed with this work for additional information</span> - <span style="color: #633820"># regarding copyright ownership. The ASF licenses this file</span> - <span style="color: #633820"># to you under the Apache License, Version 2.0 (the</span> - <span style="color: #633820"># "License"); you may not use this file except in compliance</span> - <span style="color: #633820"># with the License. You may obtain a copy of the License at</span> - <span style="color: #633820">#</span> - <span style="color: #633820"># http:</span><span style="color: #177500">//www.apache.org/licenses/LICENSE-2.0</span> - <span style="color: #633820">#</span> - <span style="color: #633820"># Unless required by applicable law or agreed to in writing,</span> - <span style="color: #633820"># software distributed under the License is distributed on an</span> - <span style="color: #633820"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> - <span style="color: #633820"># KIND, either express or implied. See the License for the</span> - <span style="color: #633820"># specific language governing permissions and limitations</span> - <span style="color: #633820"># under the License.</span> - <span style="color: #633820">#</span> - - <span style="color: #000000">pkg</span>.<span style="color: #000000">name</span>: <span style="color: #000000">project/blinky</span> - <span style="color: #000000">pkg</span>.<span style="color: #000000">vers</span>: <span style="color: #1C01CE">0.8.0</span> - <span style="color: #000000">pkg</span>.<span style="color: #000000">description</span>: <span style="color: #000000">Basic</span> <span style="color: #000000">example</span> <span style="color: #000000">application</span> <span style="color: #000000">which</span> <span style="color: #000000">blinks</span> <span style="color: #000000">an</span> <span style="color: #000000">LED</span>. - <span style="color: #000000">pkg</span>.<span style="color: #000000">author</span>: <span style="color: #000000">Marko</span> <span style="color: #000000">Kiiskila</span> <span style="color: #000000"><marko@runtime</span>.<span style="color: #000000">io></span> - <span style="color: #000000">pkg</span>.<span style="color: #000000">homepage</span>: <span style="color: #000000">http</span>:<span style="color: #177500">//mynewt.apache.org/os/get_acclimated/project2/</span> - <span style="color: #000000">pkg</span>.<span style="color: #000000">repository</span>: <span style="color: #000000">https</span>:<span style="color: #177500">//git-wip-us.apache.org/repos/asf/incubator-mynewt-larva</span> - <span style="color: #000000">pkg</span>.<span style="color: #000000">keywords</span>: - - <span style="color: #000000">pkg</span>.<span style="color: #000000">deps</span>: - <span style="color: #000000">-</span> <span style="color: #000000">libs/console/full</span> - <span style="color: #000000">-</span> <span style="color: #000000">libs/newtmgr</span> - <span style="color: #000000">-</span> <span style="color: #000000">libs/os</span> - <span style="color: #000000">-</span> <span style="color: #000000">libs/shell</span> - <span style="color: #000000">-</span> <span style="color: #000000">sys/config</span> - <span style="color: #000000">-</span> <span style="color: #000000">sys/log</span> - <span style="color: #000000">-</span> <span style="color: #000000">sys/stats</span> - <span style="color: #000000">-</span> <span style="color: #000000">libs/baselibc</span> +<p><br></p> +<h3 id="create-an-application-image-from-the-binary">Create an application image from the binary<a class="headerlink" href="#create-an-application-image-from-the-binary" title="Permanent link">¶</a></h3> +<p>You must sign and version your application image to download it using newt. Use +the <code>newt create-image</code> command to perform this action. Here we assign this +image an arbitrary version <code>1.2.3</code>.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt create-image stmf3_blinky 1.2.3 +App image succesfully generated: ~/dev/myproj/bin/stmf3_blinky/apps/blinky/blinky.img +Build manifest:~/dev/myproj/bin/stmf3_blinky/apps/blinky/manifest.json </pre></div> +<p><br></p> +<h3 id="configure-the-hardware">Configure the hardware<a class="headerlink" href="#configure-the-hardware" title="Permanent link">¶</a></h3> +<p>The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool interface that will be used to program/debug the board. To program the MCU on the board, simply plug in the two jumpers on CN4, as shown in the picture in red. If you want to learn more about the board you will find the User Manual at <a href="http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf";>http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf</a></p> <ul> -<li> -<p>Next, you get to build the targets and generate an executable that can then be uploaded to the board. The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool interface that will be used to program/debug the board. To program the MCU on the board, simply plug in the two jumpers on CN4, as shown in the picture in red. If you want to learn more about the board you will find the User Manual at <a href="http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf";>http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf</a></p> -</li> -<li> -<p><img alt="STMdiscovery" src="../pics/STM32f3discovery_connector.png" /></p> -</li> +<li><img alt="STMdiscovery" src="../pics/STM32f3discovery_connector.png" /></li> </ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">build</span> <span style="color: #000000">boot_f3disc</span> - <span style="color: #000000">Building</span> <span style="color: #000000">target</span> <span style="color: #000000">boot_f3</span> (<span style="color: #000000">project</span> <span style="color: #000000">=</span> <span style="color: #000000">boot</span>) - <span style="color: #000000">Compiling</span> <span style="color: #000000">asprintf</span>.<span style="color: #000000">c</span> - <span style="color: #000000">Compiling</span> <span style="color: #000000">atoi</span>.<span style="color: #000000">c</span> - ... - ... - <span style="color: #000000">Assembling</span> <span style="color: #000000">startup_stm32f303xc</span>.<span style="color: #000000">s</span> - <span style="color: #000000">Archiving</span> <span style="color: #000000">libstm32f3discovery</span>.<span style="color: #000000">a</span> - <span style="color: #000000">Compiling</span> <span style="color: #000000">boot</span>.<span style="color: #000000">c</span> - <span style="color: #000000">Building</span> <span style="color: #000000">project</span> <span style="color: #000000">boot</span> - <span style="color: #000000">Linking</span> <span style="color: #000000">boot</span>.<span style="color: #000000">elf</span> - <span style="color: #000000">Successfully</span> <span style="color: #000000">run!</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">build</span> <span style="color: #000000">blink_f3disc</span> - <span style="color: #000000">Building</span> <span style="color: #000000">target</span> <span style="color: #000000">blink_f3disc</span> (<span style="color: #000000">project</span> <span style="color: #000000">=</span> <span style="color: #000000">blinky</span>) - <span style="color: #000000">Compiling</span> <span style="color: #000000">asprintf</span>.<span style="color: #000000">c</span> - <span style="color: #000000">Compiling</span> <span style="color: #000000">atoi</span>.<span style="color: #000000">c</span> - ... - ... - <span style="color: #000000">Assembling</span> <span style="color: #000000">startup_stm32f303xc</span>.<span style="color: #000000">s</span> - <span style="color: #000000">Archiving</span> <span style="color: #000000">libstm32f3discovery</span>.<span style="color: #000000">a</span> - <span style="color: #000000">Compiling</span> <span style="color: #000000">main</span>.<span style="color: #000000">c</span> - <span style="color: #000000">Building</span> <span style="color: #000000">project</span> <span style="color: #000000">blinky</span> - <span style="color: #000000">Linking</span> <span style="color: #000000">blinky</span>.<span style="color: #000000">elf</span> - <span style="color: #000000">Successfully</span> <span style="color: #000000">run!</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">build</span> <span style="color: #000000">boot_f3disc</span> - <span style="color: #000000">Building</span> <span style="color: #000000">target</span> <span style="color: #000000">boot_f3disc</span> (<span style="color: #000000">project</span> <span style="color: #000000">=</span> <span style="color: #000000">boot</span>) - <span style="color: #000000">Building</span> <span style="color: #000000">project</span> <span style="color: #000000">boot</span> - <span style="color: #000000">Successfully</span> <span style="color: #000000">run!</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">create-image</span> <span style="color: #000000">blink_f3disc</span> <span style="color: #1C01CE">0.0.1</span> - <span style="color: #000000">Building</span> <span style="color: #000000">target</span> <span style="color: #000000">blink_f3disc</span> (<span style="color: #000000">project</span> <span style="color: #000000">=</span> <span style="color: #000000">blinky</span>) - <span style="color: #000000">Building</span> <span style="color: #000000">project</span> <span style="color: #000000">blinky</span> +<p><br></p> +<h3 id="download-the-images">Download the Images<a class="headerlink" href="#download-the-images" title="Permanent link">¶</a></h3> +<p>Use the <code>newt load</code> command to download the images to the target board.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt -v load stmf3_boot +$ newt -v load stmf3_blinky </pre></div> -<ul> -<li>Finally, you have to download the image on to the board. You will see a blue light start to blink.</li> -</ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">download</span> <span style="color: #000000">boot_f3disc</span> - <span style="color: #000000">Downloading</span> <span style="color: #000000">with</span> <span style="color: #000000">/Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download</span>.<span style="color: #000000">sh</span> - - [<span style="color: #000000">user</span>:<span style="color: #000000">~/dev/test_project</span>]<span style="color: #000000">$</span> <span style="color: #000000">newt</span> <span style="color: #000000">target</span> <span style="color: #000000">download</span> <span style="color: #000000">blink_f3disc</span> - <span style="color: #000000">Downloading</span> <span style="color: #000000">with</span> <span style="color: #000000">/Users/user/dev/test_project/hw/bsp/stm32f3discovery/stm32f3discovery_download</span>.<span style="color: #000000">sh</span> -</pre></div> +<p><br></p> +<h3 id="watch-the-led-blink">Watch the LED blink<a class="headerlink" href="#watch-the-led-blink" title="Permanent link">¶</a></h3> +<p>Congratulations! You have built, downloaded, and run your first application using mynewt for the +stf32f3 discovery board. One of the LEDs on the LED wheel should be blinking +at 1 Hz.</p> <div class="row"> <footer> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/tutorials/air_quality_sensor/index.html ---------------------------------------------------------------------- diff --git a/os/tutorials/air_quality_sensor/index.html b/os/tutorials/air_quality_sensor/index.html index da94490..ac92102 100644 --- a/os/tutorials/air_quality_sensor/index.html +++ b/os/tutorials/air_quality_sensor/index.html @@ -9,7 +9,7 @@ <link rel="canonical" href="http://mynewt.apache.org/os/tutorials/air_quality_sensor/";> <link rel="shortcut icon" href="../../../img/favicon.ico"> - <title>Adding an air-quality sensor - Apache Mynewt</title> + <title>Air-quality Sensor project - Apache Mynewt</title> <link href="../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> <link href="../../../css/font-awesome-4.0.3.css" rel="stylesheet"> @@ -40,7 +40,7 @@ </head> - <body class="Adding an air-quality sensor"> + <body class="Air-quality Sensor project"> <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation"> @@ -201,9 +201,7 @@ - <li><a href=" - ../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../get_started/get_started/">Get Started</a></li> </li> @@ -225,18 +223,18 @@ - <li><a href=" - ../olimex/ -">Tutorials</a> + <li ><a href="../tutorials/">Tutorials</a></li> <ul class="current-toc"> + + <li> - <a href="../olimex/">Blinky on Olimex</a> + <a href="../arduino_zero/">Blinky on Arduino Zero</a> </li> @@ -246,7 +244,7 @@ <li> - <a href="../STM32F303/">Blinky on STM32F303</a> + <a href="../olimex/">Blinky on Olimex</a> </li> @@ -256,7 +254,7 @@ <li> - <a href="../nRF52/">Blinky on nRF52</a> + <a href="../STM32F303/">Blinky on STM32F303</a> </li> @@ -266,7 +264,7 @@ <li> - <a href="../arduino_zero/">Blinky on Arduino Zero</a> + <a href="../nRF52/">Blinky on nRF52</a> </li> @@ -276,7 +274,7 @@ <li> - <a href="../unit_test/">Unit Testing a Package</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> @@ -286,7 +284,7 @@ <li class="active"> - Adding an air-quality sensor + Air-quality Sensor project </li> @@ -439,11 +437,11 @@ - <li>» <a href="../olimex/">Tutorials</a></li> + <li>» <a href="../tutorials/">Tutorials</a></li> - <li>» Adding an air-quality sensor</li> + <li>» Air-quality Sensor project</li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/tutorials/arduino_zero/index.html ---------------------------------------------------------------------- diff --git a/os/tutorials/arduino_zero/index.html b/os/tutorials/arduino_zero/index.html index cdfae48..f30f0b8 100644 --- a/os/tutorials/arduino_zero/index.html +++ b/os/tutorials/arduino_zero/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../get_started/get_started/">Get Started</a></li> </li> @@ -225,18 +223,18 @@ - <li><a href=" - ../olimex/ -">Tutorials</a> + <li ><a href="../tutorials/">Tutorials</a></li> <ul class="current-toc"> + + - <li> - <a href="../olimex/">Blinky on Olimex</a> + <li class="active"> + Blinky on Arduino Zero </li> @@ -246,7 +244,7 @@ <li> - <a href="../STM32F303/">Blinky on STM32F303</a> + <a href="../olimex/">Blinky on Olimex</a> </li> @@ -256,7 +254,7 @@ <li> - <a href="../nRF52/">Blinky on nRF52</a> + <a href="../STM32F303/">Blinky on STM32F303</a> </li> @@ -265,8 +263,8 @@ - <li class="active"> - Blinky on Arduino Zero + <li> + <a href="../nRF52/">Blinky on nRF52</a> </li> @@ -276,7 +274,7 @@ <li> - <a href="../unit_test/">Unit Testing a Package</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> @@ -286,7 +284,7 @@ <li> - <a href="../air_quality_sensor/">Adding an air-quality sensor</a> + <a href="../air_quality_sensor/">Air-quality Sensor project</a> </li> @@ -439,7 +437,7 @@ - <li>» <a href="../olimex/">Tutorials</a></li> + <li>» <a href="../tutorials/">Tutorials</a></li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/tutorials/how_to_edit_docs/index.html ---------------------------------------------------------------------- diff --git a/os/tutorials/how_to_edit_docs/index.html b/os/tutorials/how_to_edit_docs/index.html index 43a97bf..578cd3b 100644 --- a/os/tutorials/how_to_edit_docs/index.html +++ b/os/tutorials/how_to_edit_docs/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../get_started/get_started/">Get Started</a></li> </li> @@ -225,18 +223,18 @@ - <li><a href=" - ../olimex/ -">Tutorials</a> + <li ><a href="../tutorials/">Tutorials</a></li> <ul class="current-toc"> + + <li> - <a href="../olimex/">Blinky on Olimex</a> + <a href="../arduino_zero/">Blinky on Arduino Zero</a> </li> @@ -246,7 +244,7 @@ <li> - <a href="../STM32F303/">Blinky on STM32F303</a> + <a href="../olimex/">Blinky on Olimex</a> </li> @@ -256,7 +254,7 @@ <li> - <a href="../nRF52/">Blinky on nRF52</a> + <a href="../STM32F303/">Blinky on STM32F303</a> </li> @@ -266,7 +264,7 @@ <li> - <a href="../arduino_zero/">Blinky on Arduino Zero</a> + <a href="../nRF52/">Blinky on nRF52</a> </li> @@ -276,7 +274,7 @@ <li> - <a href="../unit_test/">Unit Testing a Package</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> @@ -286,7 +284,7 @@ <li> - <a href="../air_quality_sensor/">Adding an air-quality sensor</a> + <a href="../air_quality_sensor/">Air-quality Sensor project</a> </li> @@ -439,7 +437,7 @@ - <li>» <a href="../olimex/">Tutorials</a></li> + <li>» <a href="../tutorials/">Tutorials</a></li> @@ -457,138 +455,47 @@ <p>Learn the process of editing docs by adding some content to a test document.</p> <h3 id="markdown-mkdocs-mou">Markdown, MkDocs, Mou<a class="headerlink" href="#markdown-mkdocs-mou" title="Permanent link">¶</a></h3> <p>The Mynewt documentation you see on the Apache incubator website is a bunch of HTML files generated using MkDocs which is a simple static site generation tool geared towards building project documentation. You can read about it at <a href="http://www.mkdocs.org";>http://www.mkdocs.org</a>. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool (which in our case is MkDocs).</p> -<p>You do not need to install MkDocs unless you want to actually render your documentation in HTML in order to preview it before pushing your content to the remote repository. Typically, using a Markdown editor such as <a href="http://25.io/mou/";>Mou</a> is enough to check how it will look after the document has gone through MkDocs. Go ahead and download <a href="http://25.io/mou/";>Mou</a>. If you are on a Windows machine, download the <a href="http://alternativeto.net/software/mou/?platform=windows";>editor of your choice</a>.</p> -<p>Currently someone in the project is designated to use MkDocs to generate the HTML pages periodically after changes have been reviewed and accepted into the master branch.</p> +<p>The HTML pages are generated periodically after changes have been reviewed and accepted into the master branch.</p> <h3 id="access-to-the-apache-repo">Access to the Apache repo<a class="headerlink" href="#access-to-the-apache-repo" title="Permanent link">¶</a></h3> <p>Get an account on Apache. You do not need a committer account to view the website or clone the repository but you need it to push changes to it.</p> <p>If you are not a committer, you may follow the proposed non-committer workflow to share your work. The direct link to the proposed workflow is <a href="https://git-wip-us.apache.org/docs/workflow.html";>https://git-wip-us.apache.org/docs/workflow.html</a>. You will find the steps described in more detail later in this tutorial.</p> -<h3 id="making-a-local-copy">Making a local copy<a class="headerlink" href="#making-a-local-copy" title="Permanent link">¶</a></h3> -<ul> -<li>Copy the document source files into a local directory and look at the contents of the copied directory to get an idea of the directory structure. Use http instead of https if you are a non-committer.</li> -</ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">clone</span> <span style="color: #000000">https</span>:<span style="color: #177500">//git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git</span> - <span style="color: #000000">Cloning</span> <span style="color: #000000">into</span> <span style="color: #000000">'incubator-mynewt-site'</span>... - <span style="color: #000000">remote</span>: <span style="color: #000000">Counting</span> <span style="color: #000000">objects</span>: <span style="color: #1C01CE">330</span>, <span style="color: #000000">done</span>. - <span style="color: #000000">remote</span>: <span style="color: #000000">Compressing</span> <span style="color: #000000">objects</span>: <span style="color: #1C01CE">100</span><span style="color: #000000">%</span> (<span style="color: #1C01CE">263</span><span style="color: #000000">/</span><span style="color: #1C01CE">263</span>), <span style="color: #000000">done</span>. - <span style="color: #000000">remote</span>: <span style="color: #000000">Total</span> <span style="color: #1C01CE">330</span> (<span style="color: #000000">delta</span> <span style="color: #1C01CE">120</span>), <span style="color: #000000">reused</span> <span style="color: #1C01CE">0</span> (<span style="color: #000000">delta</span> <span style="color: #1C01CE">0</span>) - <span style="color: #000000">Receiving</span> <span style="color: #000000">objects</span>: <span style="color: #1C01CE">100</span><span style="color: #000000">%</span> (<span style="color: #1C01CE">330</span><span style="color: #000000">/</span><span style="color: #1C01CE">330</span>), <span style="color: #1C01CE">4.34</span> <span style="color: #000000">MiB</span> <span style="color: #000000">|</span> <span style="color: #1C01CE">830.00</span> <span style="color: #000000">KiB/s</span>, <span style="color: #000000">done</span>. - <span style="color: #000000">Resolving</span> <span style="color: #000000">deltas</span>: <span style="color: #1C01CE">100</span><span style="color: #000000">%</span> (<span style="color: #1C01CE">120</span><span style="color: #000000">/</span><span style="color: #1C01CE">120</span>), <span style="color: #000000">done</span>. - <span style="color: #000000">Checking</span> <span style="color: #000000">connectivity</span>... <span style="color: #000000">done</span>. - <span style="color: #000000">$</span> <span style="color: #000000">ls</span> - <span style="color: #000000">incubator-mynewt-site</span> - <span style="color: #000000">$</span> <span style="color: #000000">ls</span> <span style="color: #000000">incubator-mynewt-site/</span> - <span style="color: #000000">docs</span> <span style="color: #000000">images</span> <span style="color: #000000">mkdocs</span>.<span style="color: #000000">yml</span> -</pre></div> - - -<ul> -<li>Create a new branch to work on your documentation and move to that branch.</li> -</ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">checkout</span> <span style="color: #000000">-b</span> <span style="color: #000000"><your-branch-name></span> -</pre></div> - - -<h3 id="file-to-be-edited">File to be edited<a class="headerlink" href="#file-to-be-edited" title="Permanent link">¶</a></h3> -<p>The file you will edit is named try_markdown.md. It is in the incubator-mynewt-site/docs/os/tutorials/ directory.</p> <h3 id="editing-an-existing-page">Editing an existing page<a class="headerlink" href="#editing-an-existing-page" title="Permanent link">¶</a></h3> <ul> -<li> -<p>Open the application Mou.</p> -</li> -<li> -<p>Open the file incubator-mynewt-site/docs/os/tutorials/try_markdown.md in Mou.</p> -</li> -<li> -<p>Edit the last item on the list.</p> -</li> -<li> -<p>Save and quit the application.</p> -</li> -</ul> -<h3 id="adding-a-new-page">Adding a new page<a class="headerlink" href="#adding-a-new-page" title="Permanent link">¶</a></h3> -<p>If you create a new file somewhere in the <code>docs</code> subdirectory to add a new page, you have to add a line in the <code>mkdocs.yml</code> file at the correct level. For example, if you add a new module named "Ethernet" by creating a new file named <code>ethernet.md</code> in the <code>modules</code> subdirectory, you have to insert the following line under <code>Modules:</code> in the <code>mkdocs.yml</code> file.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">-</span> <span style="color: #000000">'Ethernet':</span> <span style="color: #000000">'modules/ethernet</span>.<span style="color: #000000">md'</span> -</pre></div> - - -<h3 id="pushing-changes-to-remote-as-a-committer">Pushing changes to remote as a committer<a class="headerlink" href="#pushing-changes-to-remote-as-a-committer" title="Permanent link">¶</a></h3> -<p>If you are not a committer yet, skip this section and proceed to the <a href="#sharing-changes-as-a-non-committer">next section</a>.</p> -<ul> -<li>Check whether your remote git repository is set up. If you see the remote location as shown below you can skip the next step.</li> -</ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">remote</span> <span style="color: #000000">-v</span> - <span style="color: #000000">origin</span> <span style="color: #000000">https</span>:<span style="color: #177500">//git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (fetch)</span> - <span style="color: #000000">origin</span> <span style="color: #000000">https</span>:<span style="color: #177500">//git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git (push)</span> -</pre></div> - - -<ul> -<li>If, however, you do not see your remote repository, then set it up as follows.</li> -</ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">remote</span> <span style="color: #000000">add</span> <span style="color: #000000">origin</span> <span style="color: #000000">https</span>:<span style="color: #177500">//git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git </span> -</pre></div> - - -<ul> -<li>First check the git status. It will show you that the <code>try_markdown.md</code> document has been modified. So you will stage a commit, and then commit the change. Finally, you will push the changes to the remote repository. </li> -</ul> -<p>During staging below using <code>git add</code>, we use the <code>-A</code> option indicating you want to stage all your modifications. Instead, you can choose to specify only the files that you want to. The commit message (specified after <code>-m</code>) should summarize what your changes are about.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">status</span> - <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">add</span> <span style="color: #000000">-A</span> - <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">commit</span> <span style="color: #000000">-m</span> <span style="color: #C41A16">"My first doc change as a trial run"</span> - <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">push</span> <span style="color: #000000">-u</span> <span style="color: #000000">origin</span> <span style="color: #000000"><your-branch-name></span> -</pre></div> - - -<ul> -<li> -<p>You can see the changed Markdown file if you traverse the tree on the git repository <a href="https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git";> https://git-wip-us.apache.org/repos/asf/incubator-mynewt-site.git</a>.</p> -</li> -<li> -<p>A commit notification automatically goes out to the [email protected] mailing list. The "upstream" manager pulls the notified changes, reviews it, and merges it to the master branch if all is well. Otherwise you get an email for further changes.</p> -</li> -</ul> -<h3 id="sharing-changes-as-a-non-committer">Sharing changes as a non-committer<a class="headerlink" href="#sharing-changes-as-a-non-committer" title="Permanent link">¶</a></h3> -<p>We suggest you follow the proposed non-committer workflow at Apache to share your work. The direct link to the proposed workflow is <a href="https://git-wip-us.apache.org/docs/workflow.html";>https://git-wip-us.apache.org/docs/workflow.html</a>. </p> -<ul> -<li>Assuming you have made changes to the example file, you will first commit your changes.</li> +<li>Create a fork on the <a href="https://github.com/apache/incubator-mynewt-site";>github mirror</a>. </li> +<li></li> +<li>Then create a new branch to work on your documentation and move to that branch.</li> </ul> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">add</span> <span style="color: #000000">-A</span> - <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">commit</span> <span style="color: #000000">-m</span> <span style="color: #C41A16">"My first doc change as a trial run"</span> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> $ git checkout -b <your-branch-name> </pre></div> <ul> -<li>Once you're ready to share your changes with the rest of the project team, you can use the git format-patch command to produce a patch file (or a nice set of patches in the future) and email the patch file to [email protected]. Later on you may attach multiple files in your email to the mailing list as part of an existing thread or a new one. Remember to summarize the issue you have tackled and your work if the commit message is not detailed enough.</li> +<li>Make changes directly on github.com. Generate a pull request. Alternatively, you can edit locally on your machine, push the branch (or the changes in the branch) to your fork on github.com, and then generate a pull request.</li> </ul> -<p>If there is a JIRA ticket associated with your work you should post your patch files to the ticket.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">$</span> <span style="color: #000000">git</span> <span style="color: #000000">format-patch</span> <span style="color: #000000">origin/trunk</span> +<h3 id="adding-a-new-page">Adding a new page<a class="headerlink" href="#adding-a-new-page" title="Permanent link">¶</a></h3> +<p>If you create a new file somewhere in the <code>docs</code> subdirectory to add a new page, you have to add a line in the <code>mkdocs.yml</code> file at the correct level. For example, if you add a new module named "Wi-Fi" by creating a new file named <code>wifi.md</code> in the <code>network</code> directory, you have to insert the following line under <code>Networking User Guide</code> in the <code>mkdocs.yml</code> file (at the same level as the <code>docs</code> directory). In this example, a link will show up in the navigation bar on the left under "Networking User Guide" titled "Wi-Fi" and take the user to the contents of the 'wifi.md' file when the link is clicked. <strong> Note: The change will show up on this <a href="http://mynewt.apache.org";>Mynewt site</a> only after your pull request is merged in and the updated site is generated.</strong></p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> - 'Wi-Fi': 'wifi.md' </pre></div> -<ul> -<li>Alternatively, you can use the mirror on github.com to submit a pull request. The mirror is located at <a href="https://github.com/apache/incubator-mynewt-site";>https://github.com/apache/incubator-mynewt-site</a>. It is up to you to decide whether to create a fork or a branch to work in and submit pull requests from. Remember you cannot push changes to the master on the github mirror, so you have to create a fork or a branch first. Your pull request will be reviewed by a committer for docs and merged into the master branch when the changes are understood and accepted. </li> -</ul> -<h3 id="conversion-to-html">Conversion to HTML<a class="headerlink" href="#conversion-to-html" title="Permanent link">¶</a></h3> -<p>The conversion of the Markdown files to HTML for the website happens manually and statically using MkDocs. You cannot see automatic and immediate rendering in HTML upon making a change in the Markdown file. You can choose to stop here and proceed to changing other Markdown files in your branch.</p> <h3 id="local-preview-of-html-files">Local preview of HTML files<a class="headerlink" href="#local-preview-of-html-files" title="Permanent link">¶</a></h3> -<p>However, you have the option to download MkDocs and do a local conversion yourself to preview the pages using the built-in devserver that comes with MkDocs. But first you will have to install MkDocs for that. In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have them already (usually you will).</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">$</span> <span style="color: #000000">python</span> <span style="color: #000000">--version</span> - <span style="color: #000000">Python</span> <span style="color: #1C01CE">2.7.2</span> - <span style="color: #000000">$</span> <span style="color: #000000">pip</span> <span style="color: #000000">--version</span> - <span style="color: #000000">pip</span> <span style="color: #1C01CE">1.5.2</span> - <span style="color: #000000">$</span> <span style="color: #000000">pip</span> <span style="color: #000000">install</span> <span style="color: #000000">mkdocs</span> +<p>You have the option to install MkDocs and do a local conversion yourself to preview the pages using the built-in webserver that comes with MkDocs. In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have them already (usually you will).</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> $ python --version + Python 2.7.2 + $ pip --version + pip 1.5.2 + $ pip install mkdocs </pre></div> <p>You will then run the built-in webserver from the root of the documentation directory using the command <code>mkdocs serve</code>. The root directory for documentation is <code>incubator-mynewt-site</code> or the directory with the <code>mkdocs.yml</code> file.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> <span style="color: #000000">$</span> <span style="color: #000000">ls</span> - <span style="color: #000000">docs</span> <span style="color: #000000">images</span> <span style="color: #000000">mkdocs</span>.<span style="color: #000000">yml</span> - <span style="color: #000000">$</span> <span style="color: #000000">mkdocs</span> <span style="color: #000000">serve</span> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> $ ls + docs images mkdocs.yml + $ mkdocs serve </pre></div> -<p>Then go to <a href="http://127.0.0.1:8000";>http://127.0.0.1:8000</a> to preview your pages and see how they will look on the website! Remember that the Myself website itself will not be updated.</p> +<p>Then go to <a href="http://127.0.0.1:8000";>http://127.0.0.1:8000</a> to preview your pages and see how they will look on the website. <strong>Remember that the Myself website itself will not be updated.</strong></p> <p>For more information on MkDocs go to <a href="http://www.mkdocs.org";>http://www.mkdocs.org</a>. </p> <div class="row"> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/dfb65f62/os/tutorials/nRF52/index.html ---------------------------------------------------------------------- diff --git a/os/tutorials/nRF52/index.html b/os/tutorials/nRF52/index.html index faee46b..a7665db 100644 --- a/os/tutorials/nRF52/index.html +++ b/os/tutorials/nRF52/index.html @@ -201,9 +201,7 @@ - <li><a href=" - ../../get_started/native_tools/ -">Get Started</a> + <li ><a href="../../get_started/get_started/">Get Started</a></li> </li> @@ -225,18 +223,18 @@ - <li><a href=" - ../olimex/ -">Tutorials</a> + <li ><a href="../tutorials/">Tutorials</a></li> <ul class="current-toc"> + + <li> - <a href="../olimex/">Blinky on Olimex</a> + <a href="../arduino_zero/">Blinky on Arduino Zero</a> </li> @@ -246,7 +244,7 @@ <li> - <a href="../STM32F303/">Blinky on STM32F303</a> + <a href="../olimex/">Blinky on Olimex</a> </li> @@ -255,8 +253,8 @@ - <li class="active"> - Blinky on nRF52 + <li> + <a href="../STM32F303/">Blinky on STM32F303</a> </li> @@ -265,8 +263,8 @@ - <li> - <a href="../arduino_zero/">Blinky on Arduino Zero</a> + <li class="active"> + Blinky on nRF52 </li> @@ -276,7 +274,7 @@ <li> - <a href="../unit_test/">Unit Testing a Package</a> + <a href="../unit_test/">Write a Test Suite for a Package</a> </li> @@ -286,7 +284,7 @@ <li> - <a href="../air_quality_sensor/">Adding an air-quality sensor</a> + <a href="../air_quality_sensor/">Air-quality Sensor project</a> </li> @@ -439,7 +437,7 @@ - <li>» <a href="../olimex/">Tutorials</a></li> + <li>» <a href="../tutorials/">Tutorials</a></li>
