Repository: incubator-mynewt-site Updated Branches: refs/heads/master 1832c8573 -> df9b6fb4d
Added OS user guide intro. Fixed stale links in Quick Start guides e.g. brew install instructions 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/df9b6fb4 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/df9b6fb4 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/df9b6fb4 Branch: refs/heads/master Commit: df9b6fb4d427319223685ed96bb117dd0d97776a Parents: 1832c85 Author: aditihilbert <[email protected]> Authored: Thu Mar 17 17:25:54 2016 -0700 Committer: aditihilbert <[email protected]> Committed: Thu Mar 17 17:25:54 2016 -0700 ---------------------------------------------------------------------- docs/os/get_started/native_tools.md | 4 ++-- docs/os/get_started/project_create.md | 4 ++-- docs/os/os_user_guide.md | 9 +++++++++ mkdocs.yml | 9 +++++---- 4 files changed, 18 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/df9b6fb4/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 67c0b6e..184049c 100644 --- a/docs/os/get_started/native_tools.md +++ b/docs/os/get_started/native_tools.md @@ -10,8 +10,8 @@ This page provides guidance for MAC and Linux. See the relevant sections below. ### Install Brew -if you have not already installed Homebrew from the -[`newt` tutorials pages](../../newt/newt_mac.md). +If you have not already installed Homebrew from the +[`newt` tutorials pages](../../newt/tutorials/newt_mac.md), install it. ###Install gcc/libc http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/df9b6fb4/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 510dcb6..bb46161 100644 --- a/docs/os/get_started/project_create.md +++ b/docs/os/get_started/project_create.md @@ -6,8 +6,8 @@ This page shows how to create a Mynewt Project using the `newt` command-line too * Ensure you have installed [newt](../../newt/tutorials/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](project1.md) to +* 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. <br> http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/df9b6fb4/docs/os/os_user_guide.md ---------------------------------------------------------------------- diff --git a/docs/os/os_user_guide.md b/docs/os/os_user_guide.md new file mode 100644 index 0000000..05b7608 --- /dev/null +++ b/docs/os/os_user_guide.md @@ -0,0 +1,9 @@ +# OS User Guide + +This guide provides comprehensive information about Mynewt OS, the real-time operating system for embedded systems. +It is intended both for an embedded real-time software developer as well as higher-level applications developer wanting to understand the features and benefits of the system. +Mynewt OS is highly composable and flexible. Only those features actually used by the application are compiled into the run-time image. Hence, the actual size of Mynewt is completely determined by the application. The guide covers all the features and services available in the OS and contains several examples showing how they can be used. +**Send us an email on the dev@ mailing list if you have comments or suggestions!** If you haven't joined the mailing list, you will find the links [here](../community.md). + +<br> + http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/df9b6fb4/mkdocs.yml ---------------------------------------------------------------------- diff --git a/mkdocs.yml b/mkdocs.yml index f1e0a71..5e7faa3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -12,11 +12,11 @@ pages: - Events: 'events.md' - Mynewt OS Manual: - Introduction: 'os/get_started/introduction.md' - - Get Started: + - Quick Start: - toc: 'os/get_started/get_started.md' - - 'Installing Native Tools': 'os/get_started/native_tools.md' - - 'Creating Your First Project': 'os/get_started/project_create.md' - - 'Installing Cross Tools for ARM': 'os/get_started/cross_tools.md' + - 'Install Native Tools': 'os/get_started/native_tools.md' + - 'Create Your First Project': 'os/get_started/project_create.md' + - 'Install Cross Tools for ARM': 'os/get_started/cross_tools.md' - 'Concepts': - toc: 'os/get_started/vocabulary.md' - Tutorials: @@ -29,6 +29,7 @@ pages: - 'Air-quality Sensor project': 'os/tutorials/air_quality_sensor.md' - 'Edit Docs': 'os/tutorials/how_to_edit_docs.md' - OS User Guide: + - toc: 'os/os_user_guide.md' - OS Core: - toc: 'os/core_os/mynewt_os.md' - System-level Functions:
