Fixed ordering of installation sequence - The installing native tool chain page was listed before the Installing newt tool instruction page, and told the user he can proceed to create a project at the end of the page. If the user followed this sequence, he would not have installed newt yet.
To make this more clear: 1) Added a native install introduction that list all the tools to install. 2) Moved the Install Native Toolchain to after the Installing Newt instruction. 3) Minor edits to create first project section. 4) Fixed URL references to native_tools.md to point to basic setup that covers installation option. 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/c65b92c6 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/c65b92c6 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/c65b92c6 Branch: refs/heads/develop Commit: c65b92c61f11ec203c5a9726e87073537669bfec Parents: 6a0cc6b Author: cwanda <[email protected]> Authored: Tue May 2 10:30:24 2017 -0700 Committer: cwanda <[email protected]> Committed: Wed May 3 12:56:12 2017 -0700 ---------------------------------------------------------------------- docs/faq/go_env.md | 2 +- docs/os/get_started/native_install_intro.md | 17 +++++++++++++++++ docs/os/get_started/native_tools.md | 2 +- docs/os/get_started/project_create.md | 13 ++++++------- docs/os/tutorials/add_newtmgr.md | 6 ++---- docs/os/tutorials/add_shell.md | 17 +++++++---------- docs/os/tutorials/arduino_zero.md | 2 +- docs/os/tutorials/blehci_project.md | 18 ++++++++---------- docs/os/tutorials/bletiny_project.md | 17 ++++++++--------- docs/os/tutorials/blinky.md | 2 +- mkdocs.yml | 7 ++++--- 11 files changed, 56 insertions(+), 47 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/docs/faq/go_env.md ---------------------------------------------------------------------- diff --git a/docs/faq/go_env.md b/docs/faq/go_env.md index 4b4a880..effa141 100644 --- a/docs/faq/go_env.md +++ b/docs/faq/go_env.md @@ -163,7 +163,7 @@ Check that the newtmgr binary is installed and you are using the one from **$GOP ```no-highlight $ls $GOPATH/bin/newtmgr ~/dev/go/bin/newtmgr -$which newt +$which newtmgr ~/dev/go/bin/newtmgr ``` <br> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/docs/os/get_started/native_install_intro.md ---------------------------------------------------------------------- diff --git a/docs/os/get_started/native_install_intro.md b/docs/os/get_started/native_install_intro.md new file mode 100644 index 0000000..2cadfa1 --- /dev/null +++ b/docs/os/get_started/native_install_intro.md @@ -0,0 +1,17 @@ +# Native Installation + +This section shows you how to install tools on Mac OS and Linux platforms to develop, build, run, and debug Mynewt OS applications. You can build Mynewt OS applications to run as a native application on your computer or to run on your target board. These tools include: + +* Newt tool - Tool to create, build, load, and debug a mynewt target. + + * See [Installing the Newt Tool on Mac OS](/newt/install/newt_mac.md) to install on Mac OS. + * See [Installing the Newt Tool on Linux](/newt/install/newt_linux.md) to install on Linux. + + +<br> + +* Native toolchain - Native toolchain to build and run Mynewt OS as a native application on your computer. + (See [Installing Native Toolchain](/os/get_started/native_install.md)). + +* Cross toolchain for ARM - Cross toolchain for ARM to build and run a Mynewt OS application on a target board + (See [Installing Cross Tools for ARMs](/os/get_started/cross_tools.md)). http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/docs/os/get_started/native_tools.md ---------------------------------------------------------------------- diff --git a/docs/os/get_started/native_tools.md b/docs/os/get_started/native_tools.md index 8ca3bdc..852e037 100644 --- a/docs/os/get_started/native_tools.md +++ b/docs/os/get_started/native_tools.md @@ -139,4 +139,4 @@ Setting up gdb (7.7.1-0ubuntu5~14.04.2) ... <br> -At this point you have installed all the necessary software to build and test code on a simluator running on your Mac or Linux. Proceed to the [Create Your First Project](project_create.md) section. +At this point you have installed all the necessary software to build and run your first project on a simluator on your Mac OS or Linux computer. You may proceed to the [Create Your First Project](project_create.md) section or continue to the next section and install the cross tools for ARM. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/docs/os/get_started/project_create.md ---------------------------------------------------------------------- diff --git a/docs/os/get_started/project_create.md b/docs/os/get_started/project_create.md index 2c41df3..8cdca42 100644 --- a/docs/os/get_started/project_create.md +++ b/docs/os/get_started/project_create.md @@ -4,14 +4,13 @@ This page shows how to create a Mynewt Project using the `newt` command-line too <br> -### Pre-Requisites +### Prerequisites -* Newt: +* Have Internet connectivity to fetch remote Mynewt components. +* Install Newt: + * If you have taken the native install route, see the installation instructions for [Mac OS](../../newt/install/newt_mac.md) or for [Linux](../../newt/install/newt_linux.md). * If you have taken the Docker route, you have already installed Newt. - * If you have taken the native install route, you have to ensure that you have installed the Newt tool following the instructions for [Mac](../../newt/install/newt_mac.md) or [Linux](../../newt/install/newt_linux.md) as appropriate, and that the `newt` command is in your system path. -* You must have Internet connectivity to fetch remote Mynewt components. -* You must [install the compiler tools](native_tools.md) to -support native compiling to build the project this tutorial creates. +* Install the [native toolchain](native_tools.md) to compile and build a Mynewt native application. <br> @@ -32,7 +31,7 @@ Project myproj successfully created. Newt populates this new project with a base skeleton of a new Apache Mynewt project. It has the following structure. -**Note**: If you do not have `tree`, install it by running `brew install tree`. +**Note**: If you do not have `tree`, run `brew install tree` to install on Mac OS or run `sudo apt-get install tree` to install on Linux. ```no-highlight $ cd myproj http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/docs/os/tutorials/add_newtmgr.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/add_newtmgr.md b/docs/os/tutorials/add_newtmgr.md index e2ccd24..ea43e11 100644 --- a/docs/os/tutorials/add_newtmgr.md +++ b/docs/os/tutorials/add_newtmgr.md @@ -23,12 +23,10 @@ See [Other Configuration Options](#other-configuration-options) on how to custom ### Prerequisites 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/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. * Have a cable to establish a serial USB connection between the board and the laptop. +* Install the newt tool and toolchains (See [Basic Setup](/os/get_started/get_started.md)). +* Install the [newtmgr tool](../../newtmgr/install_mac.md). <br> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/docs/os/tutorials/add_shell.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/add_shell.md b/docs/os/tutorials/add_shell.md index f3739b5..2a645eb 100644 --- a/docs/os/tutorials/add_shell.md +++ b/docs/os/tutorials/add_shell.md @@ -7,16 +7,13 @@ can interact with your project over a serial line connection. <br> -### Pre-Requisites - -* Ensure you have installed [newt](../../newt/install/newt_mac.md) and that the -newt command is in your system path. -* You must have Internet connectivity to fetch remote Mynewt components. -* You must [install the compiler tools](../get_started/native_tools.md) to -support native compiling to build the project this tutorial creates. -* You must install the [Segger JLINK package]( https://www.segger.com/jlink-software.html) to -load your project on the board. -* Cable to establish a serial USB connection between the board and the laptop +### Prerequisites +Ensure that you have met the following prerequisites before continuing with this tutorial: + +* Have Internet connectivity to fetch remote Mynewt components. +* Have a cable to establish a serial USB connection between the board and the laptop +* Install the newt tool and toolchains (See [Basic Setup](/os/get_started/get_started.md)). +* Install the [Segger JLINK package]( https://www.segger.com/jlink-software.html) to load your project on the board. <br> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/docs/os/tutorials/arduino_zero.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/arduino_zero.md b/docs/os/tutorials/arduino_zero.md index 68499b3..c7d9fc6 100644 --- a/docs/os/tutorials/arduino_zero.md +++ b/docs/os/tutorials/arduino_zero.md @@ -41,7 +41,7 @@ Run the following commands to create a new project: ###<a name="fetchexternal"></a> Fetch External Packages Mynewt uses source code provided directly from the chip manufacturer for -low level operations. Sometimes this code is licensed only for the specific manufacturer of the chipset and cannot live in the Apache Mynewt repository. That happens to be the case for the Arduino Zero board which uses Atmel SAMD21. Runtime's github repository hosts such external third-party packages and the Newt tool can fetch them. +low level operations. Sometimes this code is licensed only for the specific manufacturer of the chipset and cannot live in the Apache Mynewt repository. That happens to be the case for the Arduino Zero board which uses Atmel SAMD21. Runtime's github repository hosts such external third-party packages and the newt tool can fetch them. To fetch the package with MCU support for Atmel SAMD21 for Arduino Zero from the Runtime git repository, you need to add the repository to the `project.yml` file in your base project directory. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/docs/os/tutorials/blehci_project.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/blehci_project.md b/docs/os/tutorials/blehci_project.md index 7bf43af..199c62d 100644 --- a/docs/os/tutorials/blehci_project.md +++ b/docs/os/tutorials/blehci_project.md @@ -8,22 +8,20 @@ The host used in this specific example is the BlueZ Bluetooth stack. Since BlueZ <br> -### Pre-Requisites +### Prerequisites +Ensure that you meet the following prerequisites before continuing with one of the tutorials. -* Ensure you have installed [newt](../../newt/install/newt_mac.md) and that the -newt command is in your system path. -* You must have Internet connectivity to fetch remote Mynewt components. -* If you are not using the Docker container for newt and other tools, you must [install the compiler tools](../get_started/native_tools.md) to -support native compiling to build the project this tutorial creates. -* You have a board with BLE radio that is supported by Mynewt. We will use an nRF52 Dev board in this tutorial. -* USB TTL Serial Cable that supports hardware flow control such as ones found at [http://www.ftdichip.com/Products/Cables/USBTTLSerial.htm](http://www.ftdichip.com/Products/Cables/USBTTLSerial.htm) to establish a serial USB connection between the board and the laptop. -* You have installed a BLE host such as BlueZ on a Linux machine to talk to the nrf52 board running Mynewt. Use `sudo apt-get install bluez` to install it on your Linux machine. +* Have Internet connectivity to fetch remote Mynewt components. +* Have a board with BLE radio that is supported by Mynewt. We will use an nRF52 Dev board in this tutorial. +* Have a USB TTL Serial Cable that supports hardware flow control such as ones found at [http://www.ftdichip.com/Products/Cables/USBTTLSerial.htm](http://www.ftdichip.com/Products/Cables/USBTTLSerial.htm) to establish a serial USB connection between the board and the laptop. +* Install the newt tool and toolchains (See [Basic Setup](/os/get_started/get_started.md)). +* Install a BLE host such as BlueZ on a Linux machine to talk to the nrf52 board running Mynewt. Use `sudo apt-get install bluez` to install it on your Linux machine. <br> ### Create a project -Use the Newt tool to create a new project directory containing a skeletal Mynewt framework. Change into the newly created directory. +Use the newt tool to create a new project directory containing a skeletal Mynewt framework. Change into the newly created directory. ``` $ newt new blehciproj http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/docs/os/tutorials/bletiny_project.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/bletiny_project.md b/docs/os/tutorials/bletiny_project.md index b169d31..4426a12 100644 --- a/docs/os/tutorials/bletiny_project.md +++ b/docs/os/tutorials/bletiny_project.md @@ -8,20 +8,19 @@ This tutorial explains how to run an example BLE app on a board and command it t ### Prerequisites -* Ensure you have installed [newt](../../newt/install/newt_mac.md) and that the -newt command is in your system path. -* You must have Internet connectivity to fetch remote Mynewt components. -* You must [install the compiler tools](../get_started/native_tools.md) to -support native compiling to build the project this tutorial creates. -* You must install the [Segger JLINK package]( https://www.segger.com/jlink-software.html) to load your project on the board. -* You have a board with BLE radio that is supported by Mynewt. We will use an nRF52 Dev board in this tutorial. -* Cable to establish a serial USB connection between the board and the laptop +Ensure that you have met the following prerequisites before continuing with this tutorial: + +* Have Internet connectivity to fetch remote Mynewt components. +* Have a board with BLE radio that is supported by Mynewt. We will use an nRF52 Dev board in this tutorial. +* Have a cable to establish a serial USB connection between the board and the laptop +* Install the newt tool and toolchains (See [Basic Setup](/os/get_started/get_started.md)). +* Install the [Segger JLINK package]( https://www.segger.com/jlink-software.html) to load your project on the board. <br> ### Create a project -Use the Newt tool to create a new project directory containing a skeletal Mynewt framework. Change into the newly created directory. +Use the newt tool to create a new project directory containing a skeletal Mynewt framework. Change into the newly created directory. ```no-highlight $ newt new myproj http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/docs/os/tutorials/blinky.md ---------------------------------------------------------------------- diff --git a/docs/os/tutorials/blinky.md b/docs/os/tutorials/blinky.md index 04efdc3..3a33869 100644 --- a/docs/os/tutorials/blinky.md +++ b/docs/os/tutorials/blinky.md @@ -22,7 +22,7 @@ Ensure that you meet the following prerequisites before continuing with one of t * Have Internet connectivity to fetch remote Mynewt components. * Have a computer to build a Mynewt application and connect to the board over USB. * Have a Micro-USB cable to connect the board and the computer. -* Install the Newt tool and toolchains (See [Basic Setup](/os/get_started/get_started.md)). +* Install the newt tool and toolchains (See [Basic Setup](/os/get_started/get_started.md)). * Read the Mynewt OS [Concepts](/os/get_started/vocabulary.md) section. * Create a project space (directory structure) and populate it with the core code repository (apache-mynewt-core) or know how to as explained in [Creating Your First Project](/os/get_started/project_create). <br> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/c65b92c6/mkdocs.yml ---------------------------------------------------------------------- diff --git a/mkdocs.yml b/mkdocs.yml index 8d51e74..61fe2ce 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,10 +17,11 @@ pages: - toc: 'os/introduction.md' - Basic Setup: - toc: 'os/get_started/get_started.md' - - 'Native install Option': - - toc: 'os/get_started/native_tools.md' + - Native Install Option: + - toc: 'os/get_started/native_install_intro.md' - 'Install Newt on Mac': 'newt/install/newt_mac.md' - 'Install Newt on Linux': 'newt/install/newt_linux.md' + - 'Install Native Toolchain': 'os/get_started/native_tools.md' - 'Install Cross Tools for ARM': 'os/get_started/cross_tools.md' - 'Docker Container Option': 'os/get_started/docker.md' - 'Create Your First Project': 'os/get_started/project_create.md' @@ -28,7 +29,7 @@ pages: - Concepts: 'os/get_started/vocabulary.md' - Tutorials: - toc: 'os/tutorials/tutorials.md' - - Project Blinky: + - Project Blinky: - toc: 'os/tutorials/blinky.md' - 'Blinky on Arduino Zero': 'os/tutorials/arduino_zero.md' - 'Blinky on Arduino Primo': 'os/tutorials/blinky_primo.md'
