http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/45c390ea/develop/os/tutorials/pin-wheel-mods/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/pin-wheel-mods/index.html b/develop/os/tutorials/pin-wheel-mods/index.html deleted file mode 100644 index 27a3ac2..0000000 --- a/develop/os/tutorials/pin-wheel-mods/index.html +++ /dev/null @@ -1,681 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - - - <!-- This is broken by doc revisioning. - <link rel="canonical" href="http://mynewt.apache.org/os/tutorials/pin-wheel-mods/";> --> - <link rel="shortcut icon" href="../../../img/favicon.ico"> - - <title>Pinwheel Blinky - Apache Mynewt</title> - - <link href="../../../css/bootstrap-3.0.3.min.css" rel="stylesheet"> - <link rel="stylesheet" href="../../../css/highlight.css"> - <link href="../../../css/base.css" rel="stylesheet"> - <link href="../../../css/custom.css" rel="stylesheet"> - <link href="../../../css/v2.css" rel="stylesheet"> - <link href="https://fonts.googleapis.com/css?family=Lato"; rel="stylesheet"> - <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css";> - <link href="../../../extra.css" rel="stylesheet"> - - <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js";></script> - <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js";></script> - <![endif]--> - - - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-72162311-1', 'auto'); - ga('send', 'pageview'); - </script> - - </head> - - - <body class="Pinwheel Blinky"> - - - <div class="container"> - <div class="row v2-main-banner"> - <a class="logo-cell" href="/"> - <img class="logo" src="/img/logo.png"> - </a> - <div class="tagline-cell"> - <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> - </div> - <div class="news-cell"> - <div class="well"> - <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.0.0</a> released (March 22, 2017) - </div> - </div> - </div> -</div> - - - - - - - - -<nav id="navbar" class="navbar navbar-inverse affix-top" data-spy="affix" data-offset-top="150" role="navigation"> - <div class="container"> - <!-- Collapsed navigation --> - <div class="navbar-header"> - <!-- Expander button --> - <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> - <span class="sr-only">Toggle navigation</span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - - </div> - - <!-- Expanded navigation --> - <div class="navbar-collapse collapse"> - <!-- Main navigation --> - <ul class="nav navbar-nav navbar-right"> - <li - class="" -> - <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> - </li> - <li - class="important" -> - <a href="/quick-start/">Quick Start</a> - </li> - <li - class="" -> - <a href="/about/">About</a> - </li> - <li - class="" -> - <a href="/talks/">Talks</a> - </li> - <li - class="active" -> - <a href="/latest/os/introduction">Documentation</a> - </li> - <li - class="" -> - <a href="/download/">Download</a> - </li> - <li - class="" -> - <a href="/community/">Community</a> - </li> - <li - class="" -> - <a href="/events/">Events</a> - </li> - </ul> - - <!-- Search, Navigation and Repo links --> - <ul class="nav navbar-nav navbar-right"> - - </ul> - </div> - </div> -</nav> - - - - <div class="container"> - - <div class="row"> - <div class="col-md-3 v2-sidebar sidebar-container"><div id="docSidebar" class="hidden-print" role="complementary"> - <div class="top"> - <div role="search"> - <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> - <div class="form-group"> - <input type="text" name="q" class="form-control" placeholder="Search documentation" /> - </div> - </form> - </div> - </div> - <ul class="toc-nav"> - <li class="doc-version"> -<select class="form-control" onchange="if (this.value) window.location.href=this.value"> - - <option - value="/develop/os/introduction" - selected="selected" - > - Version: develop (latest) - </option> - - <option - value="/v0_9_0/os/introduction" - - > - Version: 0.9.0 - </option> - -</select> -</li> - - - - - - - - - - - - - - - - - - - - - - <li ><a href="../../introduction/">Mynewt Documentation</a> - - - <ul> - - - - - - - - <li ><a href="../../get_started/get_started/">Basic Setup</a> - - - </li> - - - - - - <li > - <a href="../../get_started/vocabulary/">Concepts</a> - </li> - - - - - - - - <li ><a href="../tutorials/">Tutorials</a> - - - <ul> - - - - - - - - <li ><a href="../blinky/">Project Blinky</a> - - - <ul> - - - - - - <li > - <a href="../arduino_zero/">Blinky on Arduino Zero</a> - </li> - - - - - - <li > - <a href="../blinky_primo/">Blinky on Arduino Primo</a> - </li> - - - - - - <li > - <a href="../olimex/">Blinky on Olimex</a> - </li> - - - - - - - - <li ><a href="../STM32F303/">Blinky on STM32F303</a> - - - <ul> - - - - - - <li class="active"> - <a href="./">Pinwheel Blinky</a> - </li> - - - - </ul> - - </li> - - - - - - <li > - <a href="../nRF52/">Blinky on nRF52</a> - </li> - - - - - - <li > - <a href="../rbnano2/">Blinky on RedBear Nano 2</a> - </li> - - - - - - <li > - <a href="../blinky_console/">Add Console and Shell to Blinky</a> - </li> - - - - </ul> - - </li> - - - - - - - - <li ><a href="../repo/add_repos/">Work with repositories</a> - - - </li> - - - - - - - - <li ><a href="../project-slinky/">Project Slinky for Remote Comms</a> - - - </li> - - - - - - <li > - <a href="../ibeacon/">BLE iBeacon</a> - </li> - - - - - - <li > - <a href="../eddystone/">BLE Eddystone</a> - </li> - - - - - - <li > - <a href="../add_newtmgr/">Enable Newt Manager in any app</a> - </li> - - - - - - <li > - <a href="../add_shell/">Enable the OS Shell and Console</a> - </li> - - - - - - <li > - <a href="../tasks_lesson/">Tasks and Priority Management</a> - </li> - - - - - - <li > - <a href="../wi-fi_on_arduino/">Enable Wi-Fi on Arduino MKR1000</a> - </li> - - - - - - <li > - <a href="../unit_test/">Write a Test Suite for a Package</a> - </li> - - - - - - <li > - <a href="../event_queue/">Events and Event Queues</a> - </li> - - - - - - <li > - <a href="../bletiny_project/">BLE app to check stats via console</a> - </li> - - - - - - - - <li ><a href="../bleprph/bleprph-intro/">BLE peripheral project</a> - - - </li> - - - - - - <li > - <a href="../blehci_project/">BLE HCI interface</a> - </li> - - - - - - - - <li><a href=" - ../air_quality_sensor/ -">Air-quality Sensor project</a> - - - </li> - - - - - - <li > - <a href="../nrf52_adc/">Add an Analog Sensor</a> - </li> - - - - </ul> - - </li> - - - - - - - - <li ><a href="../../os_user_guide/">OS User Guide</a> - - - </li> - - - - - - - - <li><a href=" - ../../../network/ble/ble_intro/ -">BLE User Guide</a> - - - </li> - - - - - - - - <li ><a href="../../../newt/newt_intro/">Newt Tool Guide</a> - - - </li> - - - - - - - - <li ><a href="../../../newtmgr/overview/">Newt Manager Guide</a> - - - </li> - - - - </ul> - - </li> - - - - - - - - <li><a href=" - ../../../faq/go_env/ -">Appendix</a> - - - </li> - - - - </ul> -</div></div> - - <div class="col-md-9" role="main"> - <div class="doc-header"> - <div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs pull-right"> - <li><a href="/develop/os/introduction">Docs</a></li> - - - - <li>» <a href="../blinky/">Project Blinky</a></li> - - - - <li>» <a href="../STM32F303/">Blinky on STM32F303</a></li> - - - - <li>» Pinwheel Blinky</li> - - - - </ul> -</div> - </div> - - <h2 id="pin-wheel-modifications-to-blinky-on-stm32f3-discovery">Pin Wheel Modifications to "Blinky" on STM32F3 Discovery</h2> -<p><br></p> -<h3 id="objective">Objective</h3> -<p>Learn how to modify an existing app -- the <a href="../STM32F303/">blinky</a> app -- to light all the LEDs on the STM32F3 Discovery board. </p> -<p><br></p> -<h3 id="what-you-need">What you need</h3> -<ul> -<li>Discovery kit with STM32F303VC MCU</li> -<li>Laptop running Mac OSX. </li> -<li>It is assumed you have already installed and run the <a href="../STM32F303/">blinky</a> app succesfully.</li> -</ul> -<p><br></p> -<p>Since you've already successfully created your blinky app project, you'll need to modify only one file, main.c, in order to get this app working.</p> -<p><br></p> -<p>The main.c file resides in the apps/blinky/src directory in your project folder so you can edit it with your favorite editor. You'll make the following changes:</p> -<p><br></p> -<p>Replace the line:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">g_led_pin</span>; -</pre></div> - - -<p>With the line:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">g_led_pins</span>[<span style="color: #1C01CE">8</span>] <span style="color: #000000">=</span> {<span style="color: #000000">LED_BLINK_PIN_1</span>, <span style="color: #000000">LED_BLINK_PIN_2</span>, <span style="color: #000000">LED_BLINK_PIN_3</span>, <span style="color: #000000">LED_BLINK_PIN_4</span>, <span style="color: #000000">LED_BLINK_PIN_5</span>, <span style="color: #000000">LED_BLINK_PIN_6</span>, <span style="color: #000000">LED_BLINK_PIN_7</span>, <span style="color: #000000">LED_BLINK_PIN_8</span>}; -</pre></div> - - -<p>So that you now have an array of all 8 LED Pins on the board.</p> -<p>Delete the line:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #000000">g_led_pin</span> <span style="color: #000000">=</span> <span style="color: #000000">LED_BLINK_PIN</span>; -</pre></div> - - -<p>And in its place, add the following lines to initialize all the LED_PINS correctly:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span> <span style="color: #000000">x</span>; -<span style="color: #A90D91">for</span>(<span style="color: #000000">x</span> <span style="color: #000000">=</span> <span style="color: #1C01CE">0</span>; <span style="color: #000000">x</span> <span style="color: #000000"><</span> <span style="color: #1C01CE">8</span>; <span style="color: #000000">x++</span>){ - <span style="color: #000000">hal_gpio_init_out</span>(<span style="color: #000000">g_led_pins</span>[<span style="color: #000000">x</span>], <span style="color: #1C01CE">1</span>); -} -<span style="color: #A90D91">int</span> <span style="color: #000000">p</span> <span style="color: #000000">=</span> <span style="color: #1C01CE">0</span>; -</pre></div> - - -<p>We'll use that 'p' later. Next you'll want to change the line:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #000000">os_time_delay</span>(<span style="color: #1C01CE">1000</span>); -</pre></div> - - -<p>to a shorter time in order to make it a little more interesting. A full 1 second delay doesn't look great, so try 100 for starters and then you can adjust it to your liking.</p> -<p>Finally, change the line:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #000000">hal_gpio_toggle</span>(<span style="color: #000000">g_led_pin</span>); -</pre></div> - - -<p>to look like this:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #000000">hal_gpio_toggle</span>(<span style="color: #000000">g_led_pins</span>[<span style="color: #000000">p++</span>]); -<span style="color: #000000">p</span> <span style="color: #000000">=</span> (<span style="color: #000000">p</span> <span style="color: #000000">></span> <span style="color: #1C01CE">7</span>) <span style="color: #000000">?</span> <span style="color: #1C01CE">0</span> <span style="color: #000000">:</span> <span style="color: #000000">p</span>; -</pre></div> - - -<p><br></p> -<h3 id="build-the-target-and-executables-and-download-the-images">Build the target and executables and download the images</h3> -<p>Run the same commands you used on the blinky app to build and load this one:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newt create-image stmf3_blinky 1.2.3 -App image successfully generated: ~/dev/myproj/bin/stmf3_blinky/apps/blinky/blinky.img -Build manifest:~/dev/myproj/bin/stmf3_blinky/apps/blinky/manifest.json -$ newt -v load stmf3_boot -$ newt -v load stmf3_blinky -</pre></div> - - -<p><br></p> -<h3 id="watch-the-leds-go-round-and-round">Watch the LEDs go round and round</h3> -<p>The colored LEDs should now all light up in succession, and once they're all lit, they should then go off in the same order. This should repeat continuously.</p> -<p>If you see anything missing or want to send us feedback, please do so by signing up for appropriate mailing lists on our <a href="../../../community/">Community Page</a>.</p> -<p>Keep on hacking and blinking!</p> - - <div class="row"> - - - - -<ul class="nav nav-pills" style="margin-bottom: 10px"> - <li> - - <a href=../STM32F303/> - <span class="fa fa-arrow-left"></span> - Previous: Blinky on STM32F303 - </a> - - </li> - <li class="pull-right"> - - <a href=../nRF52/> - Next: Blinky on nRF52 - <span class="fa fa-arrow-right"></span> - </a> - - </li> -</ul> - </div> - <footer class="row"> - <div class="col-xs-12"> - - <p class="copyright">Apache Mynewt (incubating) is available under Apache License, version 2.0.</p> - - </div> - <div class="col-xs-12"> - <div class="logos"> - <img src="/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> - <small class="footnote"> - MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. - </small> - <img src="/img/egg-logo2.png" alt="Apache Incubator" title="Apache Incubator"> - </div> - </div> -</footer> - </div> - </div> - - - </div> - - <script src="../../../js/jquery-1.10.2.min.js"></script> - <script src="../../../js/bootstrap-3.0.3.min.js"></script> - <script src="../../../js/highlight.pack.js"></script> - <script src="../../../js/base.js"></script> - <script src="../../../js/custom.js"></script> - - </body> -</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/45c390ea/develop/os/tutorials/project-nrf52-slinky/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/project-nrf52-slinky/index.html b/develop/os/tutorials/project-nrf52-slinky/index.html index 27c9665..45e39f2 100644 --- a/develop/os/tutorials/project-nrf52-slinky/index.html +++ b/develop/os/tutorials/project-nrf52-slinky/index.html @@ -507,6 +507,7 @@ <ul> <li>Meet the prerequisites listed in <a href="../project-slinky/">Project Slinky</a>. </li> <li>Have a Nordic nRF52-DK board. </li> +<li>Install the <a href="https://www.segger.com/jlink-software.html";>Segger JLINK Software and documentation pack</a>.</li> </ul> <h3 id="create-a-new-project">Create a New Project</h3> <p>Create a new project if you do not have an existing one. You can skip this step and proceed to <a href="#create_targets">create the targets</a> if you already have a project created or completed the <a href="../project-slinky/">Sim Slinky</a> tutorial. </p> @@ -652,7 +653,7 @@ $ <p><br></p> <h3 id="use-newtmgr-to-query-the-board">Use Newtmgr to Query the Board</h3> -<p>Run some newtmgr commands to query and receive responses back from the board (See the <a href="../newtmgr/overview">Newt Manager Guide</a> for more information on the newtmgr commands). </p> +<p>Run some newtmgr commands to query and receive responses back from the board (See the <a href="../../../newtmgr/overview">Newt Manager Guide</a> for more information on the newtmgr commands). </p> <p>Run the <code>newtmgr echo hello -c nrf52serial</code> command. This is the simplest command that requests the board to echo back the text. </p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ newtmgr echo hello -c nrf52serial hello http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/45c390ea/develop/os/tutorials/project-stm32-slinky/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/project-stm32-slinky/index.html b/develop/os/tutorials/project-stm32-slinky/index.html index d2fb5be..08d5e4d 100644 --- a/develop/os/tutorials/project-stm32-slinky/index.html +++ b/develop/os/tutorials/project-stm32-slinky/index.html @@ -511,6 +511,7 @@ <li>Have a ARM-USB-TINY-H connector with JTAG interface for debugging ARM microcontrollers (comes with the ribbon cable to hook up to the board)</li> <li>Have a USB A-B type cable to connect the debugger to your computer. </li> <li>Have a USB to TTL Serial Cable with female wiring harness.</li> +<li>Install the <a href="../../../os/get_started/cross_tools/">OpenOCD debugger</a>.</li> </ul> <h3 id="create-a-new-project">Create a New Project</h3> <p>Create a new project if you do not have an existing one. You can skip this step and proceed to <a href="#create_targets">create the targets</a> if you already have a project created or completed the <a href="../project-slinky/">Sim Slinky</a> tutorial.</p> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/45c390ea/develop/os/tutorials/rbnano2/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/rbnano2/index.html b/develop/os/tutorials/rbnano2/index.html index b6298bd..af1959e 100644 --- a/develop/os/tutorials/rbnano2/index.html +++ b/develop/os/tutorials/rbnano2/index.html @@ -265,17 +265,6 @@ - - - <li ><a href="../STM32F303/">Blinky on STM32F303</a> - - - </li> - - - - - <li > <a href="../nRF52/">Blinky on nRF52</a> </li> @@ -543,8 +532,8 @@ <ul> <li>Meet the prerequisites listed in <a href="../blinky/">Project Blinky</a>.</li> <li>Have a RedBear Nano 2 board. </li> +<li>Install a patched version of OpenOCD 0.10.0 described in <a href="../os/get_started/cross_tools/">Install OpenOCD</a>.</li> </ul> -<p><strong>Note:</strong> You must install a patched version of OpenOCD .10.0 (See <a href="../../../os/tutorials/blinky_primo">Debugger Option 2 in the Arduino Primo Blinky Tutorial</a>).</p> <h3 id="create-a-project">Create a Project</h3> <p>Create a new project if you do not have an existing one. You can skip this step and proceed to <a href="#create_targets">create the targets</a> if you already have a project created. </p> <p>Run the following commands to create a new project:</p> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/45c390ea/develop/os/tutorials/tutorials/index.html ---------------------------------------------------------------------- diff --git a/develop/os/tutorials/tutorials/index.html b/develop/os/tutorials/tutorials/index.html index cf90b0b..8db3d34 100644 --- a/develop/os/tutorials/tutorials/index.html +++ b/develop/os/tutorials/tutorials/index.html @@ -478,7 +478,6 @@ <li>You have installed Docker container of Newt tool and toolchains or you have installed them natively on your machine</li> <li>You have created a new project space (directory structure) and populated it with the core code repository (apache-mynewt-core) or know how to as explained in <a href="../../get_started/project_create">Creating Your First Project</a>.</li> <li>You have at least one of the supported development boards:<ul> -<li><a href="../STM32F303/">STM32F3 discovery kit from ST Micro</a></li> <li><a href="../arduino_zero/">Arduino Zero hardware</a></li> <li><a href="../olimex/">Olimex/STM32F407ZGT6 Cortex-M4 hardware</a></li> <li><a href="../nRF52/">nRF52 Development Kit from Nordic Semiconductor</a></li> @@ -495,15 +494,8 @@ <ul> <li><a href="../arduino_zero/">Blinky on Arduino Zero hardware</a></li> <li><a href="../olimex/">Blinky on Olimex/STM32F407ZGT6 Cortex-M4 hardware</a></li> -<li><a href="../STM32F303/">Blinky on STM32F3 discovery kit from ST Micro</a></li> <li><a href="../nRF52/">Blinky on nRF52 Development Kit from Nordic Semiconductor</a> <strong>Note:</strong> This supports BLE.</li> -</ul> -<p><br></p> -</li> -<li> -<p>Tweaking available apps to customize behavior e.g. making a more exciting LED blink pattern</p> -<ul> -<li><a href="../pin-wheel-mods/">Pinwheel Blinky on STM32F3 discovery board</a></li> +<li><a href="../rbnano2/">Blinky on Redbear Nano2</a></li> </ul> <p><br></p> </li> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/45c390ea/develop/sitemap.xml ---------------------------------------------------------------------- diff --git a/develop/sitemap.xml b/develop/sitemap.xml index c476bb9..b635405 100644 --- a/develop/sitemap.xml +++ b/develop/sitemap.xml @@ -4,7 +4,7 @@ <url> <loc>http://mynewt.apache.org/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> @@ -13,7 +13,7 @@ <url> <loc>http://mynewt.apache.org/pages/ble/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> @@ -22,7 +22,7 @@ <url> <loc>http://mynewt.apache.org/quick-start/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> @@ -30,7 +30,7 @@ <url> <loc>http://mynewt.apache.org/about/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> @@ -38,7 +38,7 @@ <url> <loc>http://mynewt.apache.org/talks/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> @@ -46,7 +46,7 @@ <url> <loc>http://mynewt.apache.org/download/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> @@ -54,7 +54,7 @@ <url> <loc>http://mynewt.apache.org/community/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> @@ -62,7 +62,7 @@ <url> <loc>http://mynewt.apache.org/events/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> @@ -71,7 +71,7 @@ <url> <loc>http://mynewt.apache.org/os/introduction/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> @@ -83,7 +83,7 @@ <url> <loc>http://mynewt.apache.org/os/get_started/vocabulary/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> @@ -123,19 +123,19 @@ <url> <loc>http://mynewt.apache.org/faq/go_env/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>http://mynewt.apache.org/faq/how_to_edit_docs/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> <url> <loc>http://mynewt.apache.org/faq/answers/</loc> - <lastmod>2017-04-24</lastmod> + <lastmod>2017-04-25</lastmod> <changefreq>daily</changefreq> </url> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/45c390ea/download/index.html ---------------------------------------------------------------------- diff --git a/download/index.html b/download/index.html index 2a69e28..4f3e0a4 100644 --- a/download/index.html +++ b/download/index.html @@ -160,22 +160,14 @@ <h3 id="code-in-development">Code in development</h3> <p>While the use of one of the official releases listed above is generally recommended, you may be interested in seeing work in progress.</p> -<p>The most recent code resides in the <code>develop</code> branch of the Mynewt git repository. You may view or fork the repositories for Mynewt OS and Newt Tool from the Apache mirror on github.com.</p> +<p>The most recent code that is fairly stable over the full OS resides in the <code>master</code> branch of the Mynewt git repository. You may view or fork the repositories for Mynewt OS and Newt Tool from the Apache mirror on github.com.</p> <ul> -<li><a href="https://github.com/apache/incubator-mynewt-core/tree/develop";>Apache Mynewt OS mirror on github.com</a></li> -<li><a href="https://github.com/apache/incubator-mynewt-newt/tree/develop";>Apache Newt Tool mirror on github.com</a></li> +<li><a href="https://github.com/apache/incubator-mynewt-core/tree/master";>Apache Mynewt OS mirror on github.com</a></li> +<li><a href="https://github.com/apache/incubator-mynewt-newt/tree/master";>Apache Newt Tool mirror on github.com</a></li> </ul> -<p>Alternatively, you can clone the desired branch using git:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ git clone git://github.com/apache/incubator-mynewt-core.git -b develop -$ git clone git://github.com/apache/incubator-mynewt-newt.git -b develop -</pre></div> - - -<p><br></p> -<p>A relatively stable version of code in progress can be found in the <code>master</code> branch of the Mynewt git repository. -You may access the code for Mynewt OS and Newt Tool from the 'master` branch of the Apache mirror on github.com or clone it using git:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ git clone git://github.com/apache/incubator-mynewt-core.git -$ git clone git://github.com/apache/incubator-mynewt-newt.git +<p>The most recent code to support a major feature (e.g. Bluetooth 5) can be found in a long-lived feature branch dedicated to that feature (bluetooth5, in the example for Bluetooth 5) and not the master. If you are interested in seeing the latest code for that feature, you can clone the desired branch using git:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ git clone git://github.com/apache/incubator-mynewt-core.git -b <feature-branch-name> +$ git clone git://github.com/apache/incubator-mynewt-newt.git -b <feature-branch-name> </pre></div> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/45c390ea/latest/faq/go_env/index.html ---------------------------------------------------------------------- diff --git a/latest/faq/go_env/index.html b/latest/faq/go_env/index.html index 17b0d97..36d3bd2 100644 --- a/latest/faq/go_env/index.html +++ b/latest/faq/go_env/index.html @@ -262,22 +262,23 @@ </div> </div> - <h2 id="contributing-to-newt-and-newtmgr-tools">Contributing to Newt and Newtmgr Tools</h2> -<p>Newt and Newtmgr are written in Go (golang). This guide shows you how to install Go and setup your environment if -you would like to contribute to the newt or newtmgr tools.</p> + <h2 id="contributing-to-newt-or-newtmgr-tools">Contributing to Newt or Newtmgr Tools</h2> +<p>Newt and Newtmgr are written in Go (golang). This guide shows you how to install Go and setup your environment to update and build the tools if you want to: </p> +<ul> +<li>Contribute to newt or newtmgr features or fix bugs.</li> +<li>Build the tools with latest updates from the master branch on a Linux platform.</li> +</ul> <p>This guide shows you how to perform the following:</p> <ol> -<li>Install Go on either Mac OS or Linux.</li> +<li>Install Go on either Mac OS X or Linux. (Tasks that are specific to each platform are called out.)</li> <li>Setup the Go environment.</li> -<li>Download the newt and newtmgr source code.</li> -<li>Build the newt and newtmgr tools.</li> +<li>Download the source, build, and install the newt or newtmgr tools.</li> <li>Update and rebuild the tools. </li> </ol> -<p>Steps 2-5 apply to both Mac OS and Linux platforms.</p> -<p><strong>Note:</strong> You will also need to read and follow the instructions from <a href="../../faq/answers/">FAQ</a> to set up your git repos to submit changes.</p> +<p><strong>Note:</strong> You will also need to read and follow the instructions from the <a href="../../faq/answers/">FAQ</a> to set up your git repos to submit changes.</p> <h3 id="step-1-installing-go">Step 1: Installing Go</h3> -<p>The latest master branch of newt and newtmgr requires GO version 1.6 or higher. -<br></p> +<p>The latest master branch of newt and newtmgr requires GO version 1.6 or higher. You can skip this step and proceed to Step 2 if you already have Go version 1.6 or higher installed.</p> +<p><br></p> <h4 id="installing-go-on-mac-os-x">Installing Go on Mac OS X</h4> <p>If you do not have Homebrew installed, run the following command. You will be prompted for your sudo password.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" @@ -325,13 +326,14 @@ go version go1.6.3 linux/amd64 <p><br></p> <h3 id="step-2-setting-up-your-go-environment">Step 2: Setting Up Your Go Environment</h3> -<p>Go provides an environment to compile Go code, construct Go packages, and import Go code. You will use Go commands to import the <strong>newt</strong> repository into your local Go environment. The Go language environment dictates a specific directory structure, or workspace in Go parlance. It must contain three sibling directories with the names <strong>src</strong>, <strong>pkg</strong> and <strong>bin</strong>: </p> +<p>This section describes the Go environment and how to setup a Go workspace. If you already have a Go workspace for your other Go projects, you can skip this step and proceed to Step 3.</p> +<p>Go provides an environment to compile Go code, construct Go packages, and import Go code. You will use Go commands to import the newt or newtmgr package repository into your local Go environment. The Go language environment dictates a specific directory structure, or workspace in Go parlance. It must contain three sibling directories with the names <strong>src</strong>, <strong>pkg</strong> and <strong>bin</strong>: </p> <ul> <li>src contains Go source files organized into packages (one package per directory)</li> <li>pkg contains package objects</li> -<li>bin contains executable commands.</li> +<li>bin contains the Go application executables that Go builds and installs.</li> </ul> -<p>The <strong>GOPATH</strong> environment variable specifies the location of your workspace. To setup this workspace environment, create a <strong>dev</strong> directory and then a <strong>go</strong> directory under it. Set the GOPATH environment variable to this directory where you will clone the newt repository.</p> +<p>The <strong>GOPATH</strong> environment variable specifies the location of your workspace. To setup this workspace environment, create a <strong>dev</strong> directory and then a <strong>go</strong> directory under it. Set the GOPATH environment variable to this directory where you will clone the newt and newtmgr repositories.</p> <div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ cd $HOME $ mkdir -p dev/go $ cd dev/go @@ -340,57 +342,113 @@ $ export GOPATH=`pwd` <p><br> -Add the export GOPATH statement to the ~/.bash_profile file and source the file:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ vi ~/.bash_profile -$ source ~/.bash_profile +Add the following export statements to your ~/.bash_profile file and source the file:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">export GOPATH=$HOME/dev/go +export PATH=$GOPATH/bin:$PATH </pre></div> <p><br></p> -<h3 id="step-3-downloading-the-source">Step 3: Downloading the Source</h3> -<p>Use Go commands to retrieve the latest source from the newt repository (currently the ASF incubator directory). Check that the directories are installed.</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ go get mynewt.apache.org/newt/... -$ ls $GOPATH/src/mynewt.apache.org/newt -DISCLAIMER NOTICE newt newtvm viper -LICENSE README.md newtmgr util yaml +<h3 id="step-3-downloading-the-source-and-installing-the-tools">Step 3: Downloading the Source and Installing the Tools</h3> +<p>Newt and newtmgr are individual Go packages and have their own git repositories. You can download the source and install one or both tools.</p> +<p>We use the <code>go get</code> command to download the source, build, and install the binary in the <strong>$GOPATH/bin</strong> directory. </p> +<p><br></p> +<h4 id="downloading-and-installing-the-newt-tool">Downloading and Installing the Newt Tool</h4> +<p>The newt Go package is <strong>mynewt.apache.org/newt/newt</strong> and is stored in the <a href="https://github.com/apache/incubator-mynewt-newt";>Apache Mynewt newt tool repository mirrored on github</a>. </p> +<p>Download the newt package source and install the tool:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$cd $GOPATH +$go get mynewt.apache.org/newt/newt +$cd $GOPATH/src/mynewt.apache.org/newt +$ls +DISCLAIMER RELEASE_NOTES.md util +INSTALLING.md build.sh viper +LICENSE newt yaml +NOTICE newtmgr +README.md newtvm +$git status +On branch master +Your branch is up-to-date with 'origin/master'. + +nothing to commit, working directory clean +</pre></div> + + +<p><br> +<strong>Note:</strong> The source code under the <strong>newtmgr</strong> directory is no longer used or updated. The current <strong>newtmgr</strong> source has its own Git repository.</p> +<p><br> +Check that the newt binary is installed and you are using the one from <strong> $GOPATH/bin</strong>:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ls $GOPATH/bin/newt +~/dev/go/bin/newt +$which newt +~/dev/go/bin/newt +$newt version +Apache Newt (incubating) version: 1.0.0-dev </pre></div> <p><br></p> -<h3 id="step-4-building-the-newt-and-newtmgr-tools">Step 4: Building the Newt and Newtmgr Tools</h3> -<p>Perform the following commands to build the tools:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ cd $GOPATH/src/mynewt.apache.org/newt/newt -$ go install -$ ls $GOPATH/bin/ -newt newtmgr newtvm +<h4 id="downloading-and-installing-the-newtmgr-tool">Downloading and Installing the Newtmgr Tool</h4> +<p>The newtmgr Go package is <strong>mynewt.apache.org/newtmgr/newtmgr</strong>. It is stored in the <a href="https://github.com/apache/incubator-mynewt-newtmgr";>Apache Mynewt newtmgr tool repository mirrored on github</a>.</p> +<p>Download the newtmgr package and install the tool:</p> +<p><strong>Note:</strong> <code>-ldflags -s</code> must be passed to the <code>go get</code> command.</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$cd $GOPATH +$go get -ldflags -s mynewt.apache.org/newtmgr/newtmgr +$cd $GOPATH/src/mynewt.apache.org/newtmgr +$ls +DISCLAIMER NOTICE newtmgr +LICENSE README.md nmxact +$git status +On branch master +Your branch is up-to-date with 'origin/master'. + +nothing to commit, working directory clean +</pre></div> + + +<p><br> +Check that the newtmgr binary is installed and you are using the one from <strong>$GOPATH/bin</strong>:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ls $GOPATH/bin/newtmgr +~/dev/go/bin/newtmgr +$which newt +~/dev/go/bin/newtmgr </pre></div> <p><br></p> -<h3 id="step-5-updating-and-rebuilding-the-tools">Step 5: Updating and Rebuilding the Tools</h3> -<p>Change to the directory where you initially installed the source: </p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ cd $GOPATH/src/mynewt.apache.org/newt +<h3 id="step-4-updating-and-rebuilding-the-tools">Step 4: Updating and Rebuilding the Tools:</h3> +<p>This section shows you how to rebuild the newt and newtmgr tools with the latest updates from the master branch or after you have made changes in your branch. </p> +<p>Here is the general procedure to rebuild either the newt or newtmgr tool. The only difference is the directory where you will be executing the commands from. You will need to repeat the procedure to rebuild both tools.</p> +<ol> +<li>Change to the directory where the local Git repository for the tool is installed.</li> +<li>Pull the latest changes from the master branch. If you made changes you will need to rebase with <strong>origin master</strong> (See <a href="../../faq/answers/">FAQ</a>).</li> +<li>Build and install the tool.</li> +</ol> +<p><br> +Change to the directory where the source for the tool is installed.</p> +<p>For the <strong>newt</strong> tool:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$cd $GOPATH/src/mynewt.apache.org/newt/newt +</pre></div> + + +<p>For the <strong>newtmgr</strong> tool:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$cd $GOPATH/src/mynewt.apache.org/newtmgr/newtmgr </pre></div> <p><br> -Pull the latest source from the repository (you can change to a different branch using git checkout [branch] if you need to)</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ git pull +After you change to the specific tool directory, get the latest updates from the master branch. If you made changes and need to rebase with the origin, add the <code>--rebase origin master</code> arguments to the <code>git pull</code> command:</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$git pull </pre></div> <p><br> -Install the tools from the latest source:</p> -<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$ cd newt -$ go install -$ cd ../newtmgr -$ go install -$ ls $GOPATH /bin/ -newt newtmgr newtvm +Build and install the tool. The updated binary will be installed in the <strong>$GOPATH/bin</strong> directory: </p> +<p>(<strong>Note:</strong> <code>-ldflags -s</code> must be passed to the <code>go install</code> command if you are rebuilding newtmgr)</p> +<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%">$go install </pre></div> -<p>This should have updated your newt and newtmgr to the latest version based on the git repository you used.</p> +<p>You can run the <code>ls -l</code> command to check the modification time for the binary to ensure the new version is installed. </p> <div class="row">
