You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ma...@apache.org on 2016/04/28 02:09:30 UTC
[03/32] incubator-mynewt-newt git commit: Updated Newt README.md with
feature/how it works info
Updated Newt README.md with feature/how it works info
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/16426f5e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/tree/16426f5e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/diff/16426f5e
Branch: refs/heads/master
Commit: 16426f5effea3b6cb98a348e4c5bdb103b5a5e43
Parents: 926fded
Author: aditihilbert <ad...@runtime.io>
Authored: Wed Mar 23 13:28:18 2016 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Wed Mar 23 13:28:18 2016 -0700
----------------------------------------------------------------------
README.md | 27 ++++++++++++++++++++++++++-
1 file changed, 26 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-newt/blob/16426f5e/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index b27d67e..9ce64a3 100644
--- a/README.md
+++ b/README.md
@@ -21,11 +21,34 @@
# Newt
-Apache Newt is a build and package management tool, designed for C and C++
+Apache Newt is a smart 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/.
+# Features
+
+Newt is a build system that can read a directory tree, build a dependency tree, and emit the right build artifacts. It then allows you to do the following:
+
+* Download built target to board
+* Generate full flash images
+* Download debug images to a target board using a debugger
+* Conditionally compile libraries & code based upon build settings
+
+Newt is also a source management system that allows you to do the following:
+
+* Create reusable source distributions (called repo) from a collection of code.
+* Use third-party components with licenses that are not comptatible with the ASF (Apache Software Foundation) license
+* Upgrade repos
+
+
+# How it Works
+
+When Newt sees a directory tree that contains a "project.yml" file, it recognizes it as the base directory of a project, and automatically builds a package tree. It can also recognize two important package directories in the package tree - "apps" and "targets", and use them to recursively resolve dependencies and build correct images for specified targets.
+
+More information can be found in the "Newt Tool Manual" under Docs at https://mynewt.apache.org/.
+
+
# Getting Started
To build Apache Newt, simply run the included build.sh script. For more
@@ -41,6 +64,8 @@ Once you've installed newt, you can get started by creating a new project:
For more information, and a tutorial for getting started, please take a look at
the [Apache Mynewt documentation](https://mynewt.apache.org/os/get_started/introduction/).
+
+
# Contributing
## Introduction