1) Moved the Note (in newt/newt_mac.md and newtmgr/install_mac.md) that tells the user to see the appendix if they want to contribute to newt or newtmgr to beginning of doc. 2) Fixed broken links for references to installing newtmgr (changed installing.md to install_mac.md)
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/f385ba5e Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/f385ba5e Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/f385ba5e Branch: refs/heads/develop Commit: f385ba5e4f49d9836930ce93a62a39a687d717bb Parents: 9d86215 Author: cwanda <[email protected]> Authored: Sun Apr 16 07:29:12 2017 -0700 Committer: cwanda <[email protected]> Committed: Sun Apr 16 22:05:17 2017 -0700 ---------------------------------------------------------------------- docs/newt/install/newt_mac.md | 11 +++++------ docs/newtmgr/install_mac.md | 13 ++++++------- docs/os/tutorials/add_newtmgr.md | 4 ++-- docs/os/tutorials/project-slinky.md | 2 +- 4 files changed, 14 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f385ba5e/docs/newt/install/newt_mac.md ---------------------------------------------------------------------- diff --git a/docs/newt/install/newt_mac.md b/docs/newt/install/newt_mac.md index dbcef45..3a4a7e0 100644 --- a/docs/newt/install/newt_mac.md +++ b/docs/newt/install/newt_mac.md @@ -1,12 +1,13 @@ ## Installing Newt on Mac OS -Newt is supported on Mac OS X 64 bits platforms and has been tested on Mac OS Maverick (10.9) and later. +Newt is supported on Mac OS X 64 bit platforms and has been tested on Mac OS 10.9 and higher. This page shows you how to install the following versions of newt: * The latest stable release version (1.0.0) * The latest from the master branch (unstable) +**Note:** If you would like to contribute to the newt tool, see [Setting Up Go Environment to Contribute to Newt and Newtmgr Tools](/faq/go_env). ### Installing Homebrew If you do not have Homebrew installed, run the following command. You will be prompted for your sudo password. @@ -52,9 +53,9 @@ Apache Newt (incubating) version: 1.0.0 **Note:** If you previously built newt from source and the output of `which newt` shows "$GOPATH/bin/newt", you will need to move "$GOPATH/bin" after "/usr/local/bin" in your $PATH. <br> -Run `newt help` to get information about newt: +Get information about newt: ```no-highlight -$ newt help +$newt help Newt allows you to create your own embedded application based on the Mynewt operating system. Newt provides both build and package management in a single tool, which allows you to compose an embedded application, and set of @@ -139,8 +140,7 @@ $newt version Apache Newt (incubating) version: 1.0.0-dev ``` <br> -####Switching Back to the Stable Release Version -You can switch back to the stable release version (1.0.0) of newt: +To switch back to the stable release version (1.0.0) of newt, you can run: ```no-highlight $brew switch mynewt-newt 1.0.0 Cleaning /usr/local/Cellar/mynewt-newt/1.0.0 @@ -150,4 +150,3 @@ $newt version Apache Newt (incubating) version: 1.0.0 ``` <br> -**Note:** If you would like to contribute to the newt tool, see [Setting Up Go Environment to Contribute to Newt and Newtmgr Tools](/faq/go_env). http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f385ba5e/docs/newtmgr/install_mac.md ---------------------------------------------------------------------- diff --git a/docs/newtmgr/install_mac.md b/docs/newtmgr/install_mac.md index c0cbca1..5586c2b 100644 --- a/docs/newtmgr/install_mac.md +++ b/docs/newtmgr/install_mac.md @@ -1,12 +1,13 @@ ## Installing Newtmgr on Mac OS -Newtmgr is supported on Mac OS X 64 bits platforms and has been tested on Mac OS Maverick (10.9) and later. +Newtmgr is supported on Mac OS X 64 bit platforms and has been tested on Mac OS 10.9 and higher. This page shows you how to install the following versions of newtmgr: * The latest stable release version (1.0.0) * The latest from the master branch (unstable) +**Note:** If you would like to contribute to the newtmgr tool, see [Setting Up Go Environment to Contribute to Newt and Newtmgr Tools](/faq/go_env). ### Adding the runtimeco/homebrew-mynewt Tap: You should have added the runtimeco/homebrew-mynewt tap when you installed the *newt* tool. Run the following commands if you have not done so: @@ -40,7 +41,7 @@ lrwxr-xr-x 1 user staff 42 Apr 15 09:14 /usr/local/bin/newtmgr -> ../Cellar/m **Note:** If you previously built newtmgr from source and the output of `which newtmgr` shows "$GOPATH/bin/newtmgr", you will need to move "$GOPATH/bin" after "/usr/local/bin" in your $PATH. <br> -Run `newtmgr help` to get information about newtgmr: +Get information about newtmgr: ```no-highlight $newtmgr help Newtmgr helps you manage remote devices running the Mynewt OS @@ -89,7 +90,7 @@ $brew unlink mynewt-newtmgr <br> Install the latest unstable version of newtmgr from the master branch: ```no-highlight -brew install --HEAD mynewt-newtmgr +$brew install --HEAD mynewt-newtmgr ==> Installing mynewt-newtmgr from runtimeco/mynewt ==> Cloning https://github.com/apache/incubator-mynewt-newt.git Cloning into '/Users/<user>/Library/Caches/Homebrew/mynewt-newtmgr--git'... @@ -103,13 +104,11 @@ Resolving deltas: 100% (154/154), done. ðº /usr/local/Cellar/mynewt-newtmgr/HEAD-409f7d3: 3 files, 15.1MB, built in 14 seconds ``` <br> -####Switching Back to the Stable Release Version -You can switch back to the stable release version (1.0.0) of newtmgr: +To switch back to the stable release version (1.0.0) of newtmgr, you can run: ```no-highlight -brew switch mynewt-newtmgr 1.0.0 +$brew switch mynewt-newtmgr 1.0.0 Cleaning /usr/local/Cellar/mynewt-newtmgr/1.0.0 Cleaning /usr/local/Cellar/mynewt-newtmgr/HEAD-409f7d3 1 links created for /usr/local/Cellar/mynewt-newtmgr/1.0.0 ``` <br> -**Note:** If you would like to contribute to newtmgr tool, see [Setting Up Go Environment to Contribute to Newt and Newtmgr Tools](/faq/go_env). http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f385ba5e/docs/os/tutorials/add_newtmgr.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/add_newtmgr.md b/docs/os/tutorials/add_newtmgr.md index 658560f..e2ccd24 100644 --- a/docs/os/tutorials/add_newtmgr.md +++ b/docs/os/tutorials/add_newtmgr.md @@ -24,7 +24,7 @@ See [Other Configuration Options](#other-configuration-options) on how to custom Ensure that you have met the following prerequisites before continuing with this tutorial: * Install the [newt tool](../../newt/install/newt_mac.md). -* Install the [newtmgr tool](../../newtmgr/installing.md). +* Install the [newtmgr tool](../../newtmgr/install_mac.md). * Have Internet connectivity to fetch remote Mynewt components. * Install the [compiler tools](../get_started/native_tools.md) to support native compiling to build the project this tutorial creates. @@ -166,7 +166,7 @@ follow the [instructions](../../newtmgr/command_list/newtmgr_conn.md) for settin <br> -###Connecting with Your Application +###Communicate with Your Application Once you have a connection profile set up, you can connect to your device with ```newtmgr -c myconn <command>``` to run commands in your application. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f385ba5e/docs/os/tutorials/project-slinky.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/project-slinky.md b/docs/os/tutorials/project-slinky.md index d639ce3..10c62ad 100644 --- a/docs/os/tutorials/project-slinky.md +++ b/docs/os/tutorials/project-slinky.md @@ -20,7 +20,7 @@ Ensure that you meet the following prerequisites before continuing with this tut * Have a Micro-USB cable to connect the board and the computer. * Have a [serial port setup](/os/get_started/serial_access.md). * Install the newt tool and the toolchains (See [Basic Setup](/os/get_started/get_started.md)). -* Install the [newtmgr tool](../../newtmgr/installing/). +* Install the [newtmgr tool](/newtmgr/install_mac.md). * Read the Mynewt OS [Concepts](/os/get_started/vocabulary.md) section. * Create a project space (directory structure) and populated it with the core code repository (apache-mynewt-core) or kn ow how to as explained in [Creating Your First Project](/os/get_started/project_create).
