mynewt-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sterl...@apache.org
Subject incubator-mynewt-newt git commit: add installing, readme and release notes files
Date Mon, 14 Mar 2016 21:26:01 GMT
Repository: incubator-mynewt-newt
Updated Branches:
  refs/heads/develop 92fc0d118 -> a00cb8ac8


add installing, readme and release notes files


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/a00cb8ac
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/tree/a00cb8ac
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/diff/a00cb8ac

Branch: refs/heads/develop
Commit: a00cb8ac8bbe6e9415f91075382ec1dbdc586e7c
Parents: 92fc0d1
Author: Sterling Hughes <sterling@apache.org>
Authored: Mon Mar 14 14:25:51 2016 -0700
Committer: Sterling Hughes <sterling@apache.org>
Committed: Mon Mar 14 14:25:51 2016 -0700

----------------------------------------------------------------------
 INSTALLING.md    | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md        |  99 ++++++++++++++++++++++++++++++++++++++++++++++++
 RELEASE_NOTES.md |  31 +++++++++++++++
 3 files changed, 233 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/blob/a00cb8ac/INSTALLING.md
----------------------------------------------------------------------
diff --git a/INSTALLING.md b/INSTALLING.md
new file mode 100644
index 0000000..2bd8f28
--- /dev/null
+++ b/INSTALLING.md
@@ -0,0 +1,103 @@
+# Installing Newt
+
+There are two methods for the installation of newt.  From source, and 
+binary releases.  This document contains information on how to do both.
+
+# Downloading Binary Newt
+
+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.
+
+Once you have go installed, you must install the Apache Mynewt sources 
+in: 
+
+  $GOPATH/src/mynewt.apache.org/newt 
+
+You can do this by either using go get: 
+
+  $ go get -v mynewt.apache.org/newt
+
+Or manually git cloning the directory: 
+  
+  $ 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: 
+
+  $ 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: 
+
+  $ go install -v
+
+This should install the newt binary in the following location:
+
+  $GOPATH/bin
+
+Which should be added to your path during the installation of Go. 
+
+You can test the installation by typing 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 
+help for, for help on how to use a specific command
+
+Usage:
+  newt [flags]
+  newt [command]
+
+Examples:
+  newt
+  newt help [<command-name>]
+    For help on <command-name>.  If not specified, print this message.
+
+Available Commands:
+  version      Display the Newt version number.
+  install      Install project dependencies
+  upgrade      Upgrade project dependencies
+  new          Create a new project
+  info         Show project info
+  target       Command for manipulating targets
+  build        Builds one or more apps.
+  clean        Deletes app build artifacts.
+  test         Executes unit tests for one or more packages
+  load         Load built target to board
+  debug        Open debugger session to target
+  size         Size of target components
+  create-image Add image header to target binary
+  run          build/create-image/download/debug <target>
+
+Flags:
+  -h, --help              help for newt
+  -l, --loglevel string   Log level, defaults to WARN. (default "WARN")
+  -o, --outfile string    Filename to tee log output to
+  -q, --quiet             Be quiet; only display error output.
+  -s, --silent            Be silent; don't output anything.
+  -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/a00cb8ac/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..98397c9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,99 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+-->
+
+# Newt
+
+Newt is a build and package management tool, designed for C and C++ 
+applications in embedded contexts.  Newt was developed as a part of the 
+Apache Mynewt Operating System, more information on Apache Mynewt can be found 
+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/
+
+Once you've installed newt, you can get started by creating a new project: 
+
+```no-highlight
+  $ newt new your\_project
+```
+
+For more information, and a tutorial for getting started, please take a look at 
+the [Apache Mynewt documentation](http://mynewt.apache.org/os/get_started/introduction/).
+
+# Contributing 
+
+## Introduction
+
+Anybody who works with Apache Mynewt can be a contributing member of the 
+community that develops and deploys it.  The process of releasing an operating 
+system for microcontrollers is never done: and we welcome your contributions
+to that effort.
+
+## Pull Requests
+
+Apache Mynewt welcomes pull request via Github.  Discussions are done on Github,
+but depending on the topic, can also be relayed to the official Apache Mynewt
+developer mailing list dev@mynewt.incubator.apache.org.
+
+If you are suggesting a new feature, please email the developer list directly,
+with a description of the feature you are planning to work on.  
+
+We do not merge pull requests directly on Github, all PRs will be pulled and 
+pushed through http://git.apache.org/.
+
+## Filing Bugs
+
+Bugs can be filed on the 
+[Apache Mynewt Bug Tracker](https://issues.apache.org/jira/browse/MYNEWT).
+
+Where possible, please include a self-contained reproduction case!
+
+## Feature Requests
+
+Feature requests should also be filed on the 
+[Apache Mynewt Bug Tracker](https://issues.apache.org/jira/browse/MYNEWT).  
+Please introduce it as a ticket type "Wish." 
+
+## Writing Tests
+
+We love getting newt tests!  Apache Mynewt is a huge undertaking, and improving
+code coverage is a win for every Apache Mynewt user.  
+
+## Writing Documentation
+
+Contributing to documentation (in addition to writing tests), is a great way 
+to get involved with the Apache Mynewt project.
+
+Pull requests to the apache-mynewt-site repository on Github are the best 
+way to submit documentation.  For more information on contributing to the 
+documentation, the [FAQ](http://mynewt.apache.org/faq/answers/) has some 
+more information.
+
+## Getting Help
+
+If you are having trouble contributing to Apache Mynewt, or just want to talk 
+to a human about what you're working on, you can contact us via the 
+[developers mailing list](mailto:dev@mynewt.incubator.apache.org).  
+
+Although not a formal channel, you can also find a number of core developers
+on the #mynewt channel on Freenode.

http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/blob/a00cb8ac/RELEASE_NOTES.md
----------------------------------------------------------------------
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
new file mode 100644
index 0000000..ff0a2c0
--- /dev/null
+++ b/RELEASE_NOTES.md
@@ -0,0 +1,31 @@
+# RELEASE NOTES
+
+14 Mar 2016 - Apache Mynewt V0.8 Beta 2 
+
+This is the first source release of the "New" Newt.  More information on the 
+genesis of Newt, and a description can be found 
+[here](http://mail-archives.apache.org/mod_mbox/incubator-mynewt-dev/201603.mbox/browser).
+
+As an early beta release of Newt, all the normal caveats apply:
+
+  * APIs and commands may change without warning
+
+  * There are definitely bugs hiding around many corners
+
+However, the belief is that this version of newt represents the going forward 
+architecture of the Newt tool in Apache Mynewt.  So people who are interested 
+in playing around and using Newt, are encouraged to download and begin to 
+evaluate it.
+
+Future versions will add: 
+
+  * More robust package management and versioning
+
+  * Plenty of helper commands for seeing what's installed, what's changed, 
+    and why things failed.
+
+The next release of the Newt tool is planned for April 15th, 2016.  If working on 
+next-generation build and source package management systems sounds exciting to you,
+get in touch, by sending a mail to the Apache Mynewt Developer's list, dev@mynewt.incubator.apache.org.
+
+


Mime
View raw message