You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by GitBox <gi...@apache.org> on 2018/01/11 04:05:51 UTC
[GitHub] vrahane closed pull request #124: Setup & Getting Started docs
vrahane closed pull request #124: Setup & Getting Started docs
URL: https://github.com/apache/mynewt-newt/pull/124
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/install/index.rst b/docs/install/index.rst
index 3acbbc78..76163487 100644
--- a/docs/install/index.rst
+++ b/docs/install/index.rst
@@ -2,7 +2,7 @@ Install
-----------------
.. toctree::
- :titlesonly:
+ :maxdepth: 2
newt_mac
newt_linux
diff --git a/docs/install/newt_linux.rst b/docs/install/newt_linux.rst
index 41b7fa93..60900f0c 100644
--- a/docs/install/newt_linux.rst
+++ b/docs/install/newt_linux.rst
@@ -1,205 +1,160 @@
Installing Newt on Linux
------------------------
-You can install the latest release (1.1.0) of the newt tool from a
-Debian binary package (amd64). You can also download and build the
-latest release version of newt from source.
+You can install the latest release (1.3.0) of the newt tool from a Debian binary package (amd64). You can also download
+and build the latest release version of newt from source.
This page shows you how to:
-1. Set up your computer to download Debian binary packages from the
- runtimeco APT repository.
- **Note:** The key for signing the repository has changed. If you set
- up your computer before release 1.1.0, you will need to download and
- import the public key again.
+1. Set up your computer to download Debian binary packages from the runtimeco APT repository.
-2. Install the latest release version of newt from a Debian binary
- package. You can use apt-get to install the package or manually
- download and install the Debian binary package.
+ **Note:** The key for signing the repository has changed. If you set up your computer before release 1.1.0, you will
+ need to download and import the public key again.
-3. Download, build, and install the latest release version of newt from
- source.
+2. Install the latest release version of newt from a Debian binary package. You can use apt-get to install the package
+ or manually download and install the Debian binary package.
-4. Install an earlier version of newt.
+3. Download, build, and install the latest release version of newt from source.
-If you are installing on an amd64 platform, we recommend that you
-install from the binary package.
+If you are installing on an amd64 platform, we recommend that you install from the binary package.
-**Note:** We have tested the newt tool binary and apt-get install from
-the runtimeco APT repository for Ubuntu version 16. Earlier Ubuntu
-versions (for example: Ubuntu 14) may have incompatibility with the
-repository. You can manually download and install the Debian binary
-package.
+See :doc:`prev_releases` to install an earlier version of newt.
-**Note:** See :doc:`Setting Up a Go Environment to Contribute to Newt and
-Newtmgr Tools </misc/go_env>` if you want to:
+**Note:** We have tested the newt tool binary and apt-get install from the runtimeco APT repository for Ubuntu version
+1704. Earlier Ubuntu versions (for example: Ubuntu 14) may have incompatibility with the repository. You can manually
+download and install the Debian binary package.
-- Use the newt tool with the latest updates from the master branch. The
- master branch may be unstable and we recommend that you use the
- latest stable release version.
-- Contribute to the newt tool.
+**Note:** See :doc:`../../misc/go_env` if you want to:
-Setting Up Your Computer to use apt-get to Install the Package
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The newt Debian packages are stored in a private APT repository on
-**https://github/runtimeco/debian-mynewt**. To use apt-get, you must set
-up the following on your computer to retrieve packages from the
-repository:
-
-**Note**: You only need to perform this setup once on your computer.
-However, if you previously downloaded and imported the public key for
-the runtimeco APT repository, you will need to perform step 2 again as
-the key has changed.
+- Use the newt tool with the latest updates from the master branch. The master branch may be unstable and we recommend
+ that you use the latest stable release version.
+- Contribute to the newt tool.
-1. Install the ``apt-transport-https`` package to use HTTPS to retrieve
- packages.
-2. Download the public key for the runtimeco APT repository and import
- the key into the apt keychain.
-3. Add the repository for the binary and source packages to the apt
- source list.
+Setting Up Your Computer to use apt-get to Install the Package
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Install the apt-transport-https package:
+The newt Debian packages are stored in a private APT repository on **https://github/runtimeco/debian-mynewt**. To use
+apt-get, you must set up the following on your computer to retrieve packages from the repository:
-.. code-block:: console
+**Note**: You only need to perform this setup once on your computer. However, if you previously downloaded and imported
+the public key for the runtimeco APT repository, you will need to perform step 2 again as the key has changed.
- $sudo apt-get update
- $sudo apt-get install apt-transport-https
+1. Download the public key for the runtimeco APT repository and import the key into the apt keychain.
+2. Add the repository for the binary and source packages to the apt source list.
-Download the public key for the runtimeco apt repo (**Note:** There is a
-``-`` after ``apt-key add``):
+Download the public key for the runtimeco apt repo (**Note:** There is a ``-`` after ``apt-key add``):
.. code-block:: console
- wget -qO - https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/mynewt.gpg.key | sudo apt-key add -
+ $ wget -qO - https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/mynewt.gpg.key | sudo apt-key add -
-Add the repository for the binary and source packages to the
-``mynewt.list`` apt source list file.
+Add the repository for the binary and source packages to the ``mynewt.list`` apt source list file:
.. code-block:: console
- $sudo -s
- [sudo] password for <user>:
- root$ cat > /etc/apt/sources.list.d/mynewt.list <<EOF
+ $ sudo tee /etc/apt/sources.list.d/mynewt.list <<EOF
deb https://raw.githubusercontent.com/runtimeco/debian-mynewt/master latest main
EOF
- root$exit
-
-**Note:** Do not forget to exit the root shell.
-
-Verify the content of the source list file:
-
-.. code-block:: console
-
- $more /etc/apt/sources.list.d/mynewt.list
- deb https://raw.githubusercontent.com/runtimeco/debian-mynewt/master latest main
Update the available packages:
.. code-block:: console
- $sudo apt-get update
+ $ sudo apt-get update
-**Note:** If you are not using Ubuntu version 16, you may see the
-following errors. We have provided instructions on how to manually
-download and install the binary package.
+**Note:** If you are not using Ubuntu version 1704, you may see the following errors. We have provided instructions on
+how to manually download and install the binary package.
.. code-block:: console
+ W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/source/Sources HttpError404
- W: Failed to fetch https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/dists/latest/main/source/Sources Ht
- tpError404
-
-## Installing the Latest Release of Newt from a Binary Package
+Installing the Latest Release of Newt from a Binary Package
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-You can use either apt-get to install the package, or manually download
-and install the Debian binary package.
+You can use either apt-get to install the package, or manually download and install the Debian binary package.
-#### Method 1: Using apt-get to Upgrade or to Install
+Method 1: Using apt-get to Upgrade or to Install
+==============================================================================================
-Run the following commands to upgrade or install the latest version of
-newt:
+Run the following commands to upgrade or install the latest version of newt:
.. code-block:: console
-
$ sudo apt-get update
$ sudo apt-get install newt
-#### Method 2: Downloading and Installing the Debian Package Manually
-
-Download and install the package manually.
+**Note:** If you encounter build errors (such as missing ``sys/mman.h``), please make sure you have a 32-bit glibc:
.. code-block:: console
- $wget https://raw.githubusercontent.com/runtimeco/debian-mynewt/master/pool/main/n/newt/newt_1.1.0-1_amd64.deb
- $sudo dpkg -i newt_1.1.0-1_amd64.deb
+ $ sudo apt-get install gcc-multilib
-See `Checking the Installed Version of Newt <#check>`__ to verify that
-you are using the installed version of newt.
+Method 2: Downloading and Installing the Debian Package Manually
+==============================================================================================
-### Installing the Latest Release of Newt from a Source Package
+Download and install the package manually.
-If you are running Linux on a different architecture, you can build and
-install the latest release version of newt from source.
+.. code-block:: console
-1. You need Go version 1.7.6 or higher to build Newt version 1.0.0.
-Currently, the latest Go version that Ubuntu installs is 1.6. Run
-``go version`` to check if you have Go 1.7.6 installed. You can download
-Go from https://golang.org/dl/.
+ $ wget https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.3.0/newt_1.3.0-1_amd64.deb
+ $ sudo dpkg -i newt_1.3.0-1_amd64.deb
-2. Download and unpack the newt source:
+See `Checking the Installed Version of Newt`_ to verify that you are using the installed version of newt.
-.. code-block:: console
+Installing the Latest Release of Newt from a Source Package
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+If you are running Linux on a different architecture, you can build and install the latest release version of newt from
+source.
- $ wget -P /tmp https://github.com/apache/mynewt-newt/archive/mynewt_1_1_0_tag.tar.gz
- $ tar -xzf /tmp/mynewt_1_1_0_tag.tar.gz
+#. Download and unpack the newt source:
-3. Run the build.sh to build the newt tool.
+ .. code-block:: console
-.. code-block:: console
+ $ wget -P /tmp https://github.com/apache/mynewt-newt/archive/mynewt_1_3_0_tag.tar.gz
+ $ tar -xzf /tmp/mynewt_1_3_0_tag.tar.gz
+
+#. Run the build.sh to build the newt tool.
+ .. code-block:: console
- $ cd mynewt-newt-mynewt_1_1_0_tag
+ $ cd mynewt-newt-mynewt_1_3_0_tag
$ ./build.sh
- $ rm /tmp/mynewt_1_1_0_tag.tar.gz
+ $ rm /tmp/mynewt_1_3_0_tag.tar.gz
-4. You should see the ``newt/newt`` executable. Move the executable to
-a bin directory in your PATH:
+#. You should see the ``newt/newt`` executable. Move the executable to a bin directory in your PATH:
-- If you previously built newt from the master branch, you can move the
- binary to your $GOPATH/bin directory.
+ - If you previously built newt from the master branch, you can move the binary to your $GOPATH/bin directory.
-.. code-block:: console
+ .. code-block:: console
$ mv newt/newt $GOPATH/bin
-- If you are installing newt for the first time and do not have a Go
- workspace set up, you can move the binary to /usr/bin or a directory
- in your PATH:
+ - If you are installing newt for the first time and do not have a Go workspace set up, you can move the binary to
+ /usr/bin or a directory in your PATH:
-.. code-block:: console
+ .. code-block:: console
$ mv newt/newt /usr/bin
- ### Checking the Installed Version of Newt
+Checking the Installed Version of Newt
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-1. Check which newt you are using and that the version is the latest
-release version.
+1. Check which newt you are using and that the version is the latest release version.
-.. code-block:: console
+ .. code-block:: console
- $which newt
+ $ which newt
/usr/bin/newt
- $newt version
- Apache Newt version: 1.1.0
+ $ newt version
+ Apache Newt version: 1.3.0
2. Get information about newt:
-.. code-block:: console
+ .. code-block:: console
- $newt
+ $ newt
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
@@ -250,18 +205,3 @@ release version.
-v, --verbose Enable verbose output when executing commands
Use "newt [command] --help" for more information about a command.
-
-### Installing Earlier Release Versions of Newt
-
-You can download and install an earlier version of newt.
-
-1. Run ``sudo apt-get remove newt`` command the current installation.
-
-2. Download and install the package. For example, run the following
-commands to install the 1.0.0 version of newt:
-
-.. code-block:: console
-
-
- $ wget https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.0.0/newt_1.0.0-1_amd64.deb
- $ sudo dpkg -i newt_1.0.0-1_amd64.deb
diff --git a/docs/install/newt_mac.rst b/docs/install/newt_mac.rst
index 353f0b26..0c1333c0 100644
--- a/docs/install/newt_mac.rst
+++ b/docs/install/newt_mac.rst
@@ -9,7 +9,7 @@ This page shows you how to:
- Upgrade to or install the latest release version of newt.
- Install the latest newt from the master branch (unstable).
-See `Installing Previous Releases of Newt <prev_releases>`__ to install an earlier version of newt.
+See :doc:`prev_releases` to install an earlier version of newt.
**Note:** If you would like to contribute to the newt tool, see :doc:`Setting Up Go Environment to Contribute
to Newt and Newtmgr Tools </misc/go_env>`.
@@ -35,7 +35,6 @@ If this is your first time installing newt, add the
.. code-block:: console
-
$ brew tap runtimeco/homebrew-mynewt
$ brew update
@@ -43,67 +42,67 @@ Upgrading to or Installing the Latest Release Version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Perform the following to upgrade or install the latest release version
-of newt (1.1.0).
+of newt.
Upgrading to the Latest Release Version of Newt
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-If you previously installed newt 1.0.0 using brew, run the following
-commands to upgrade to newt 1.1.0:
+If you previously installed newt using brew, run the following
+commands to upgrade to newt latest:
.. code-block:: console
-
$ brew update
$ brew upgrade mynewt-newt
+ ==> Upgrading 1 outdated package, with result:
+ runtimeco/mynewt/mynewt-newt 1.3.0
+ ==> Upgrading runtimeco/mynewt/mynewt-newt
+ ==> Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.3.0/mynewt-newt-1.3.0.sierra.bottle.tar.gz
+ ==> Downloading from https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.3.0/mynewt-newt-1.3.0.sierra.bottle.tar.gz
+ ######################################################################## 100.0%
+ ==> Pouring mynewt-newt-1.3.0.sierra.bottle.tar.gz
+ ? /usr/local/Cellar/mynewt-newt/1.3.0: 3 files, 7.9MB
- #### Installing the Latest Release Version of Newt
+Installing the Latest Release Version of Newt
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Run the following command to install the latest release version (1.1.0)
-of newt:
+Run the following command to install the latest release version of newt:
.. code-block:: console
-
$ brew update
$ brew install mynewt-newt
==> Installing mynewt-newt from runtimeco/mynewt
- ==> Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.1.0/mynewt-newt-1.1.0.sierra.bottle.tar.gz
- ==> Downloading from https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/mynewt-newt-1.1.0.sierra.bottle.tar.gz
- ######################################################################## 100.0%
- ==> Pouring mynewt-newt-1.1.0.sierra.bottle.tar.gz
- ? /usr/local/Cellar/mynewt-newt/1.1.0: 3 files, 10.5MB
+ ==> Downloading https://github.com/runtimeco/binary-releases/raw/master/mynewt-newt-tools_1.3.0/mynewt-newt-1.3.0.sierra.bottle.tar.gz
+ Already downloaded: /Users/gavin/Library/Caches/Homebrew/mynewt-newt-1.3.0.sierra.bottle.tar.gz
+ ==> Pouring mynewt-newt-1.3.0.sierra.bottle.tar.gz
+ ? /usr/local/Cellar/mynewt-newt/1.3.0: 3 files, 7.9MB
- **Notes:** Homebrew bottles for newt 1.1.0 are available for Mac OS
-Sierra, El Captian, and Yosemite. If you are running an earlier version
-of Mac OS, the installation will install the latest version of Go and
-compile newt locally.
+**Notes:** Homebrew bottles for newt are available for Mac OS Sierra. If you are running an earlier version of Mac OS,
+the installation will install the latest version of Go and compile newt locally.
- ### Checking the Installed Version
+Checking the Installed Version
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Check that you are using the installed version of newt:
.. code-block:: console
-
- $which newt
+ $ which newt
/usr/local/bin/newt
- $ls -l /usr/local/bin/newt
- lrwxr-xr-x 1 user staff 36 Jul 25 19:04 /usr/local/bin/newt -> ../Cellar/mynewt-newt/1.1.0/bin/newt
- $newt version
- Apache Newt version: 1.1.0
+ $ newt version
+ Apache Newt version: 1.3.0
**Note:** If you previously built newt from source and the output of
``which newt`` shows
-":math:`GOPATH/bin/newt", you will need to move "`\ GOPATH/bin" after
-"/usr/local/bin" for your PATH in ~/.bash\_profile, and source
-~/.bash\_profile.
+"$GOPATH/bin/newt", you will need to move "$GOPATH/bin" after
+"/usr/local/bin" for your PATH in ~/.bash_profile, and source
+~/.bash_profile.
- Get information about newt:
+Get information about newt:
.. code-block:: console
-
$ 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
@@ -156,90 +155,35 @@ Check that you are using the installed version of newt:
Use "newt [command] --help" for more information about a command.
- ### Installing Earlier Release Versions of Newt
-
-If you want to install newt 1.0, run the following commands:
-
-.. code-block:: console
-
-
- $ brew update
- $ brew install mynewt-newt@1.0
-
-**Note:** This is a keg-only installation. newt 1.0 is installed in
-/usr/local/Cellar/mynewt-newt@1.0/1.0.0/bin but not symlinked into
-/usr/local/bin.
-
-If you need this version of newt first in your PATH, run the following
-commands:
-
-.. code-block:: console
-
-
- $ echo 'export PATH=/usr/local/Cellar/mynewt-newt@1.0/1.0.0/bin:$PATH' >> ~/.bash_profile
- $ source ~/.bash_profile
-
- You can also manually symlink into /usr/local/bin as follows:
-
-1. Unlink newt if you have the latest version of newt installed:
-
- ::
-
- $ brew unlink mynewt-newt
-
-2. Link mynewt-newt@1.0 into /usr/local/bin:
-
- ::
-
- $ brew link -f mynewt-newt@1.0
-
Installing Newt from the Master Branch
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-We recommend that you use the latest release version (1.1.0) of newt. If
+We recommend that you use the latest release version of newt. If
you would like to use the master branch with the latest updates, you can
install newt from the HEAD of the master branch.
-\*\* Notes: \*\*
+**Notes:**
- The master branch may be unstable.
- This installation will install the latest version of Go on your
computer, if it is not installed, and compile newt locally.
- If you previously installed newt using brew, unlink the current
+If you previously installed newt using brew, unlink the current
version:
.. code-block:: console
- $brew unlink mynewt-newt
+ $ brew unlink mynewt-newt
- Install the latest unstable version of newt from the master branch:
+Install the latest unstable version of newt from the master branch:
.. code-block:: console
$ brew install mynewt-newt --HEAD
- ==> Installing mynewt-newt from runtimeco/mynewt
- ==> Cloning https://github.com/apache/mynewt-newt.git
- Cloning into '/Users/wanda/Library/Caches/Homebrew/mynewt-newt--git'...
- remote: Counting objects: 624, done.
- remote: Compressing objects: 100% (502/502), done.
- remote: Total 624 (delta 156), reused 322 (delta 85), pack-reused 0
- Receiving objects: 100% (624/624), 1.11 MiB | 0 bytes/s, done.
- Resolving deltas: 100% (156/156), done.
- ==> Checking out branch master
- ==> go install
- ? /usr/local/Cellar/mynewt-newt/HEAD-5a6266e: 3 files, 10.5MB, built in 5 seconds
- $newt version
- Apache Newt version: 1.1.0-dev
-
- To switch back to the latest stable release version (1.1.0) of newt,
+
+To switch back to the latest stable release version of newt,
you can run:
.. code-block:: console
- $brew switch mynewt-newt 1.1.0
- Cleaning /usr/local/Cellar/mynewt-newt/1.1.0
- Cleaning /usr/local/Cellar/mynewt-newt/HEAD-5a6266e
- 1 links created for /usr/local/Cellar/mynewt-newt/1.1.0
- $newt version
- Apache Newt version: 1.1.0
+ $ brew switch mynewt-newt 1.3.0
diff --git a/docs/install/newt_windows.rst b/docs/install/newt_windows.rst
index 12389ecb..5d5e7534 100644
--- a/docs/install/newt_windows.rst
+++ b/docs/install/newt_windows.rst
@@ -1,203 +1,167 @@
Installing Newt on Windows
--------------------------
-You can develop and build Mynewt OS applications for your target boards
-on the Windows platform. This guide shows you how to install the latest
-release version of newt from binary or from source. The tool is written
-in Go (golang).
-
-In Windows, we use MinGW as the development environment to build and run
-Mynewt OS applications for target boards. MinGW runs the bash shell and
-provides a Unix-like environment. This provides a uniform way to build
-Mynewt OS applications. The Mynewt documentation and tutorials use Unix
-commands and you can use the same Unix commands on MinGW to follow the
-tutorials. The documentation will note any commands or behaviors that
-are specific to Windows.
+You can develop and build Mynewt OS applications for your target boards on the Windows platform. This guide shows you how to
+install the latest release version of newt from binary or from source. The tool is written in Go (golang).
+
+In Windows, we use MinGW as the development environment to build and run Mynewt OS applications for target boards. MinGW runs the
+bash shell and provides a Unix-like environment. This provides a uniform way to build Mynewt OS applications. The Mynewt
+documentation and tutorials use Unix commands and you can use the same Unix commands on MinGW to follow the tutorials. The
+documentation will note any commands or behaviors that are specific to Windows.
This guide shows you how to perform the following:
1. Install MSYS2/MinGW.
2. Install Git.
-3. Install latest release of newt (1.2.0) from binary.
+3. Install latest release (1.2.0) of newt from binary.
4. Install latest release of newt from source.
-See `Installing Previous Releases of
-Newt </newt/install/prev_releases>`__ to install an earlier version of
-newt. You still need to set up your MinGW development environment.
+See :doc:`prev_releases` to install an earlier version of newt. You still need
+to set up your MinGW development environment.
-**Note:** If you would like to contribute to the newt tool, see :doc:`Setting
-Up Go Environment to Contribute to Newt and Newtmgr
-Tools </misc/go_env>`.
+**Note:** If you would like to contribute to the newt tool, see :doc:`../../misc/go_env`.
Installing MSYS2/MinGW
-^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-MSYS2/MinGW provides a bash shell and tools
-to build applications that run on Windows. It includes three subsystems:
+MSYS2/MinGW provides a bash shell and tools to build applications that run on Windows. It includes
+three subsystems:
- MSYS2 toolchain to build POSIX applications that run on Windows.
- MinGW32 toolchains to build 32 bit native Windows applications.
- MinGW64 toolchains to build 64 bit native Windows applications.
-The subsystems run the bash shell and provide a Unix-like environment.
-You can also run Windows applications from the shell. We will use the
-MinGW subsystem.
+The subsystems run the bash shell and provide a Unix-like environment. You can also run Windows applications from the shell. We
+will use the MinGW subsystem.
-**Note:** You can skip this installation step if you already have MinGW
-installed (from an earlier MSYS2/MinGW or Git Bash installation), but
-you must list the **bin** path for your installation in your Windows
-Path. For example: if you installed MSYS2/MinGW in the **C:\\msys64** directory, add
-**C:\\msys64\\usr\\bin** to your
-Windows Path. If you are using Windows 10 WSL, ensure that you use the
-**C:\\msys64\\usr\\bin\\bash.exe** and not the Windows 10 WSL bash.
+**Note:** You can skip this installation step if you already have MinGW installed (from an earlier MSYS2/MinGW or Git Bash
+installation), but you must list the **bin** path for your installation in your Windows Path. For example: if you installed
+MSYS2/MinGW in the **C:\\msys64** directory, add **C:\\msys64\\usr\\bin**
+to your Windows Path. If you are using Windows 10 WSL, ensure that you use the
+**C:\\msys64\\usr\\bin\\base.exe** and not the Windows 10 WSL bash.
To install and setup MSYS2 and MinGW:
-1. Download and run the `MSYS2 installer <http://www.msys2.org>`__.
- Select the 64 bit version if you are running on a 64 bit platform.
- Follow the prompts and check the ``Run MSYS2 now`` checkbox on the
- ``Installation Complete`` dialog.
-2. In the MSYS2 terminal, run the ``pacman -Syuu`` command. If you get a
- message to run the update again, close the terminal and run the
- ``pacman -Syuu`` command in a new terminal.
+1. Download and run the `MSYS2 installer <http://www.msys2.org>`__. Select the 64 bit version if you are running on a 64 bit
+ platform. Follow the prompts and check the ``Run MSYS2 now`` checkbox on the ``Installation Complete`` dialog.
+2. In the MSYS2 terminal, run the ``pacman -Syuu`` command. If you get a message to run the update again, close the terminal and
+ run the ``pacman -Syuu`` command in a new terminal.
- To start a new MSYS2 terminal, select the "MSYS2 MSYS" application
- from the Windows start menu.
+ To start a new MSYS2 terminal, select the "MSYS2 MSYS" application from the Windows start menu.
-3. Add a new user variable named **MSYS2\_PATH\_TYPE** and set the value
- to **inherit** in your Windows environment. This enables the MSYS2
- and MinGW bash to inherit your Windows user **Path** values.
+3. Add a new user variable named **MSYS2_PATH_TYPE** and set the value to **inherit** in your Windows environment. This enables
+ the MSYS2 and MinGW bash to inherit your Windows user **Path** values.
- To add the variable, select properties for your computer > Advanced
- system settings > Environment Variables > New
+ To add the variable, select properties for your computer > Advanced system settings > Environment Variables > New
-4. Add the MinGW **bin** path to your Windows Path. For example: if you
- install MSYS2/MinGW in the **C:\\msys64** directory, add
- **C:\\msys64\\usr\\bin** to
- your Windows Path.
+4. Add the MinGW **bin** path to your Windows Path. For example: if you install MSYS2/MinGW in the **C:\\msys64**
+ directory, add **C:\\msys64\\usr\\bin** to your Windows Path.
**Note:** If you are using Windows 10 WSL, ensure that you use the
- **C:\\msys64\\usr\\bin\\bash.exe**
- and not the Windows 10 WSL bash.
+ **C:\\msys64\\usr\\bin\\base.exe** and not the Windows 10 WSL bash.
5. Run the ``pacman -Su vim`` command to install the vim editor.
- **Note:** You can also use a Windows editor. You can access your
- files from the
- **C:\\\<msys-install-folder\>\\home\\\<username\>** folder,
- where **msys-install-folder** is the folder you installed MSYS2 in.
- For example, if you installed MSYS2 in the **msys64** folder, your
- files are stored in
- **C:\\msys64\\home\\\<username\>**
+ **Note:**\ You can also use a Windows editor. You can access your files from the
+ **C:<msys-install-folder>\\home\\<username>** folder, where **msys-install-folder** is the folder you installed
+ MSYS2 in. For example, if you installed MSYS2 in the **msys64** folder, your files are stored in
+ **C:\\msys64\\home\\<username>**
+
+6. Run the ``pacman -Su tar`` command to install the tar tool.
-You will need to start a MinGW terminal to run the commands specified in
-the Mynewt documentation and tutorials. To start a MinGW terminal,
-select the "MSYS2 Mingw" application from the start Menu (you can use
-either MinGW32 or MinGW64). In Windows, we use the MinGW subsystem to
-build Mynewt tools and applications.
+You will need to start a MinGW terminal to run the commands specified in the Mynewt documentation and tutorials. To start a MinGW
+terminal, select the "MSYS2 Mingw" application from the start Menu (you can use either MinGW32 or MinGW64). In Windows, we use the
+MinGW subsystem to build Mynewt tools and applications.
Installing Git for Windows
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-Download and install `Git for
-Windows <https://git-for-windows.github.io>`__ if it is not already
-installed.
+Download and install `Git for Windows <https://git-for-windows.github.io>`__ if it is not already installed.
Installing the Latest Release of the Newt Tool from Binary
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-You can install the latest release of newt from binary. It has been
-tested on Windows 10 64 bit platform.
+You can install the latest release of newt from binary. It has been tested on Windows 10 64 bit platform.
1. Start a MinGW terminal.
2. Download the newt binary tar file:
-.. code-block:: console
+ .. code-block:: console
- $ wget -P /tmp https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.2.0/newt_1_2_0_windows_amd64.tar.gz
+ $ wget -P /tmp https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.3.0/newt_1_3_0_windows_amd64.tar.gz
3. Extract the file:
-- If you previously built newt from the master branch, you can extract
- the file into your $GOPATH/bin directory. Note: This overwrites the
- current newt.exe in the directory and assumes that you are using
- $GOPATH/bin for your Go applications.
+ - If you previously built newt from the master branch, you can extract the file into your $GOPATH/bin directory. Note: This
+ overwrites the current newt.exe in the directory and assumes that you are using $GOPATH/bin for your Go applications.
-.. code-block:: console
+ .. code-block:: console
- $ tar -xzf /tmp/newt_1_2_0_windows_amd64.tar.gz -C $GOPATH/bin
+ tar -xzf /tmp/newt_1_3_0_windows_amd64.tar.gz -C $GOPATH/bin
-- If you are installing newt for the first time and do not have a Go
- workspace setup, you can extract into /usr/bin directory:
+ - If you are installing newt for the first time and do not have a Go workspace setup, you can extract into /usr/bin directory:
-.. code-block:: console
+ .. code-block:: console
- $ tar -xzf /tmp/newt_1_2_0_windows_amd64.tar.gz -C /usr/bin
+ tar -xzf /tmp/newt_1_3_0_windows_amd64.tar.gz -C /usr/bin
-4. Verify the installed version of newt. See `Checking the Installed
-Version <#check_newt>`__.
+4. Verify the installed version of newt. See `Checking the Installed Version`_.
Installing the Latest Release of Newt From Source
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-If you have an older version of Windows or a 32 bit platform, you can
-build and install the latest release version of newt from source.
+If you have an older version of Windows or a 32 bit platform, you can build and install the latest release version of newt from
+source.
-1. If you do not have Go installed, download and install the latest
-version of `Go <https://golang.org/dl/>`__. Newt requires Go version
-1.7.6 or higher.
+1. If you do not have Go installed, download and install the latest version of `Go <https://golang.org/dl/>`__. Newt requires Go
+ version 1.7.6 or higher.
2. Start a MinGw terminal.
3. Download and unpack the newt source:
-.. code-block:: console
+ .. code-block:: console
- $ wget -P /tmp https://github.com/apache/mynewt-newt/archive/mynewt_1_2_0_tag.tar.gz
- $ tar -xzf /tmp/mynewt_1_2_0_tag.tar.gz
+ $ wget -P /tmp https://github.com/apache/mynewt-newt/archive/mynewt_1_3_0_tag.tar.gz
+ $ tar -xzf /tmp/mynewt_1_3_0_tag.tar.gz
4. Run the build.sh to build the newt tool.
-.. code-block:: console
+ .. code-block:: console
- $ cd mynewt-newt-mynewt_1_2_0_tag
+ $ cd mynewt-newt-mynewt_1_3_0_tag
$ ./build.sh
- $ rm /tmp/mynewt_1_2_0_tag.tar.gz
+ $ rm /tmp/mynewt_1_3_0_tag.tar.gz
-5. You should see the ``newt/newt.exe`` executable. Move the executable
-to a bin directory in your PATH:
+5. You should see the ``newt/newt.exe`` executable. Move the executable to a bin directory in your PATH:
-- If you previously built newt from the master branch, you can move the
- executable to the $GOPATH/bin directory.
+ - If you previously built newt from the master branch, you can move the executable to the $GOPATH/bin directory.
-.. code-block:: console
+ .. code-block:: console
$ mv newt/newt.exe $GOPATH/bin
-- If you are installing newt for the first time and do not have a Go
- workspace set up, you can move the executable to /usr/bin or a
- directory in your PATH:
+ - If you are installing newt for the first time and do not have a Go workspace set up, you can move the executable to /usr/bin or
+ a directory in your PATH:
-.. code-block:: console
+ .. code-block:: console
$ mv newt/newt.exe /usr/bin
Checking the Installed Version
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1. Check the version of newt:
-.. code-block:: console
+ .. code-block:: console
$ newt version
- Apache Newt version: 1.2.0
+ Apache Newt version: 1.3.0
2. Get information about newt:
-.. code-block:: console
-
- $ newt help
+ .. code-block:: console
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
diff --git a/docs/install/prev_releases.rst b/docs/install/prev_releases.rst
index b190c3f8..3c9a1922 100644
--- a/docs/install/prev_releases.rst
+++ b/docs/install/prev_releases.rst
@@ -1,30 +1,24 @@
Installing Previous Releases of Newt
------------------------------------
-This page shows you how to install previous releases of newt for Mac OS,
-Linux, and Windows.
+This page shows you how to install previous releases of newt for Mac OS, Linux, and Windows.
Mac OS
~~~~~~
-You can install previous releases of newt using ``mynewt-newt@X.Y``
-Homebrew formulas, where X.Y is a version number.
+You can install previous releases of newt using ``mynewt-newt@X.Y`` Homebrew formulas, where X.Y is a version number.
-For example, if you want to install newt 1.0, run the following
-commands:
+For example, if you want to install newt 1.0, run the following commands:
.. code-block:: console
-
$ brew update
$ brew install mynewt-newt@1.0
-**Note:** This is a keg-only installation. newt 1.0 is installed in
-/usr/local/Cellar/mynewt-newt@1.0/1.0.0/bin but not symlinked into
-/usr/local/bin.
+**Note:** This is a keg-only installation. newt 1.0 is installed in /usr/local/Cellar/mynewt-newt@1.0/1.0.0/bin but not symlinked
+into /usr/local/bin.
-If you need this version of newt first in your PATH, run the following
-commands:
+If you need this version of newt first in your PATH, run the following commands:
.. code-block:: console
@@ -36,54 +30,55 @@ You can also manually symlink into /usr/local/bin as follows:
1. Unlink newt if you have the latest version of newt installed:
-.. code-block:: console
+ .. code-block:: console
$ brew unlink mynewt-newt
2. Link mynewt-newt@1.0 into /usr/local/bin:
-.. code-block:: console
+ .. code-block:: console
$ brew link -f mynewt-newt@1.0
- ### Linux 1. Download the binary:
+Linux
+~~~~~~
+
+1. Download the binary:
+
+ +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Version | Download |
+ +===========+====================================================================================================================================================+
+ | 1.0.0 | `newt\_1.0.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.0.0/newt_1.0.0-1_amd64.deb>`__ |
+ +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
+ | 1.1.0 | `newt\_1.1.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newt_1.1.0-1_amd64.deb>`__ |
+ +-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
-+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
-| Version | Download |
-+===========+====================================================================================================================================================+
-| 1.0.0 | `newt\_1.0.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.0.0/newt_1.0.0-1_amd64.deb>`__ |
-+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
-| 1.1.0 | `newt\_1.1.0-1\_amd64.deb <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newt_1.1.0-1_amd64.deb>`__ |
-+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------+
+2. Run the ``sudo apt-get remove newt`` command to remove the the current installation.
-2. Run the ``sudo apt-get remove newt`` command to remove the the
-current installation.
+3. Install the package. For example, run ``sudo dpkg -i newt_1.0.0-1_amd64.deb`` to install newt 1.0.0
-3. Install the package. For example, run
-``sudo dpkg -i newt_1.0.0-1_amd64.deb`` to install newt 1.0.0
+Windows
+~~~~~~~~
- ### Windows 1. Download the binary:
+1. Download the binary:
-+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Version | Download |
-+===========+================================================================================================================================================================+
-| 1.1.0 | `newt\_1\_1\_0\_windows\_amd64.tar.gz <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newt_1.1.0-1_amd64.deb>`__ |
-+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Version | Download |
+ +===========+=========================================================================================================================================================================+
+ | 1.1.0 | `newt\_1\_1\_0\_windows\_amd64.tar.gz <https://raw.githubusercontent.com/runtimeco/binary-releases/master/mynewt-newt-tools_1.1.0/newt_1_1_0_windows_amd64.tar.gz>`__ |
+ +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2. Extract the file:
-- If you previously built newt from the master branch, you can extract
- the file into your $GOPATH/bin directory. Note: This overwrites the
- current newt.exe in the directory and assumes that you are using
- $GOPATH/bin for your Go applications.
+ - If you previously built newt from the master branch, you can extract the file into your $GOPATH/bin directory. Note: This
+ overwrites the current newt.exe in the directory and assumes that you are using $GOPATH/bin for your Go applications.
- ::
+ .. code-block:: console
- tar -xzf newt_1_1_0_windows_amd64.tar.gz -C $GOPATH/bin
+ tar -xzf newt_1_1_0_windows_amd64.tar.gz -C $GOPATH/bin
-- If you are installing newt for the first time and do not have a Go
- workspace setup, you can extract into /usr/bin directory:
+ - If you are installing newt for the first time and do not have a Go workspace setup, you can extract into /usr/bin directory:
- ::
+ .. code-block:: console
tar -xzf newt_1_1_0_windows_amd64.tar.gz -C /usr/bin
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services