Update newt installation docs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/commit/cd6087c6 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/tree/cd6087c6 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/diff/cd6087c6 Branch: refs/heads/develop Commit: cd6087c6ce0c1bc7b0d5b2ddb2b1d0560681a4cd Parents: 9a826fd Author: Christopher Collins <[email protected]> Authored: Wed Mar 16 19:10:19 2016 -0700 Committer: Christopher Collins <[email protected]> Committed: Wed Mar 16 19:10:19 2016 -0700 ---------------------------------------------------------------------- INSTALLING.md | 78 ++++++++++++++++-------------------------------------- README.md | 4 +-- build.sh | 7 ++++- 3 files changed, 31 insertions(+), 58 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/blob/cd6087c6/INSTALLING.md ---------------------------------------------------------------------- diff --git a/INSTALLING.md b/INSTALLING.md index 77398cf..885f6cf 100644 --- a/INSTALLING.md +++ b/INSTALLING.md @@ -1,79 +1,49 @@ # Installing Newt -There are two methods for the installation of newt, either from source, or +There are two methods for the installation of newt, either from source, or from a binary release. This document contains information on how to do both. # Downloading Binary Newt -Binary releases of newt will be published on the Apache Mynewt website +Binary releases of newt will be published on the Apache Mynewt website when available. To find these, please go to https://mynewt.apache.org/. # Installing From Source -The newt tool is written in Go (https://golang.org/). In order to build -Apache Mynewt, you must have Go 1.6 installed on your system. Please -visit the Golang website for more information on installing Go. +The newt tool is written in Go (https://golang.org/). In order to build Apache +Mynewt, you must have Go 1.5 or later installed on your system. Please visit +the Golang website for more information on installing Go (https://golang.org/). -Once you have go installed, you must install the Apache Mynewt sources -in: - -```no-highlight - $GOPATH/src/mynewt.apache.org/newt -``` - -You can do this by either using go get: - -```no-highlight - $ go get -v mynewt.apache.org/newt -``` - -Or manually git cloning the directory: - -```no-highlight - $ mkdir -p $GOPATH/src/mynewt.apache.org/ - $ cd $GOPATH/src/mynewt.apache.org/ - $ git clone https://github.com/apache/incubator-mynewt-newt -``` - -*NOTE:* To get the latest development version of newt, you should checkout the -"develop" branch, once you've cloned newt. The master branch represents the -latest stable newt. - -Once you've done this, the next step is to install newt's dependencies, this -can be done with the go get command: - -```no-highlight - $ cd $GOPATH/src/mynewt.apache.org/newt/newt - $ go get -v -``` - -Once you've fetched all the sources, the final step is to install newt. To do this -issue the go install command: +Once you have Go installed, you can build newt by running the contained +build.sh script. This script will create the newt executable with the +following path, relative to the source directory: ```no-highlight - $ go install -v + newt/newt ``` -This should install the newt binary in the following location: +If you do not wish to run the included script, you can build newt manually with Go as follows (executed from the source directory): ```no-highlight - $GOPATH/bin + $ mkdir "$GOPATH"/src/mynewt.apache.org + $ cp -r * "$GOPATH"/src/mynewt.apache.org # Or untar to this path + $ go install mynewt.apache.org/newt/newt ``` -Which should be added to your path during the installation of Go. +This puts the newt binary in $GOPATH/bin -You can test the installation by typing newt: +You can test the installation by running newt: ```no-highlight $ 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 -projects, and then build the necessary artifacts from those projects. For more -information on the Mynewt operating system, please visit -https://mynewt.apache.org/. - -Please use the newt help command, and specify the name of the command you want +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 +projects, and then build the necessary artifacts from those projects. For more +information on the Mynewt operating system, please visit +https://mynewt.apache.org/. + +Please use the newt help command, and specify the name of the command you want help for, for help on how to use a specific command Usage: @@ -110,6 +80,4 @@ Flags: -v, --verbose Enable verbose output when executing commands. Use "newt [command] --help" for more information about a command. -$ ``` - http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/blob/cd6087c6/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 2f6abe9..c87f125 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,8 @@ at https://mynewt.apache.org/. # Getting Started -For information on how to install Newt, please read [INSTALLING](/INSTALLING.md) -or the documentation on https://mynewt.apache.org/ +For information on how to install Newt, please read +[INSTALLING](/INSTALLING.md) or the documentation on https://mynewt.apache.org/ Once you've installed newt, you can get started by creating a new project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/blob/cd6087c6/build.sh ---------------------------------------------------------------------- diff --git a/build.sh b/build.sh index e31efb7..d0b433c 100755 --- a/build.sh +++ b/build.sh @@ -15,7 +15,7 @@ then exit 1 fi -### Create a temporary go tree in /tmp and build newt. +### Create a temporary go tree in /tmp. installdir="$(realpath "$(dirname "$0")")" godir="$(mktemp -d /tmp/mynewt.XXXXXXXXXX)" mynewtdir="$godir"/src/mynewt.apache.org @@ -26,10 +26,15 @@ dstfile="$installdir"/newt/newt mkdir -p "$mynewtdir" ln -s "$installdir" "$repodir" +### Build newt. ( cd "$newtdir" + + printf "Building newt. This may take a minute...\n" GOPATH="$godir" GO15VENDOREXPERIMENT=1 go install + mv "$godir"/bin/newt "$dstfile" + printf "Successfully built executable: %s\n" "$dstfile" )
