Quick Start page updated to recommend native install
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/6f5c8273 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/6f5c8273 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/6f5c8273 Branch: refs/heads/develop Commit: 6f5c8273b7837fc309d2ba704402954ad4d7d4e0 Parents: 8f4e423 Author: aditihilbert <[email protected]> Authored: Tue Apr 18 12:35:58 2017 -0700 Committer: aditihilbert <[email protected]> Committed: Tue Apr 18 12:35:58 2017 -0700 ---------------------------------------------------------------------- docs/os/get_started/get_started.md | 10 ++++++++-- mkdocs.yml | 2 +- 2 files changed, 9 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6f5c8273/docs/os/get_started/get_started.md ---------------------------------------------------------------------- diff --git a/docs/os/get_started/get_started.md b/docs/os/get_started/get_started.md index caf895f..86bc56e 100644 --- a/docs/os/get_started/get_started.md +++ b/docs/os/get_started/get_started.md @@ -4,11 +4,17 @@ If you are curious about Mynewt and want to get a quick feel for the project, yo <br> -**Option 1** is the quick and easy way to get up and running with Mynewt. The Newt tool and build toolchains are all available in a single [All-in-one Docker Container](docker.md) that you can install on your laptop or computer. +**Option 1** is an easy, self-contained way to get up and running with Mynewt - but has limitations! The Newt tool and build toolchains are all available in a single [All-in-one Docker Container](docker.md) that you can install on your laptop or computer. + +However, this is not a long-term option since support is not likely for all features useful or critical to embedded systems development. For example, USB device mapping available in the Docker toolkit (used in this Option 1) is no longer available in the new Docker releases. The Docker option is also typically slower than the native install option. + +<span style="color:red"> Therefore, the recommended option is Option 2 below. </span> <br> -**Option 2** allows you to install the Newt tool, instances of the Mynewt OS (for simulated targets), and toolchains for developing embedded software (e.g. GNU toolchain) natively on your laptop or computer. You may want this if you are already familiar with such environments or are concerned about performance on your machine. Follow the instructions to [install native tools](native_tools.md) and [install cross tools for ARM](cross_tools.md) if you prefer this option. +**Option 2 (Recommended)** allows you to install the Newt tool, instances of the Mynewt OS (for simulated targets), and toolchains for developing embedded software (e.g. GNU toolchain) natively on your laptop or computer. We have tried to make the process easy. For example, for the Mac OS we created brew formulas. + +You want this option if you are familiar with such environments or are concerned about performance on your machine. Follow the instructions to [install native tools](native_tools.md) and [install cross tools for ARM](cross_tools.md) if you prefer this option. <br> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/6f5c8273/mkdocs.yml ---------------------------------------------------------------------- diff --git a/mkdocs.yml b/mkdocs.yml index 4eba014..61d89cf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,12 +17,12 @@ pages: - toc: 'os/introduction.md' - Basic Setup: - toc: 'os/get_started/get_started.md' - - 'Docker Container Option': 'os/get_started/docker.md' - 'Native install Option': - toc: 'os/get_started/native_tools.md' - 'Install Newt on Mac': 'newt/install/newt_mac.md' - 'Install Newt on Linux': 'newt/install/newt_linux.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' - 'Serial Port Setup': 'os/get_started/serial_access.md' - Concepts: 'os/get_started/vocabulary.md'
