summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorAmar Takhar <amar@rtems.org>2015-04-16 15:26:21 -0400
committerAmar Takhar <amar@rtems.org>2015-04-16 15:26:21 -0400
commit87db514f2dfff5ad67863a30f075b718706de346 (patch)
tree31edc1b1700de9f3d4825822534928f8a213d53f /README
downloadumon-87db514f2dfff5ad67863a30f075b718706de346.tar.bz2
Initial commit of the umon repository.
Prior to this three changes were made: * Remove umon_ prefix from parent directories. * Collapse main/target/ into main/ * Remove ports/template/flashtest.scr.ucon script.
Diffstat (limited to 'README')
-rw-r--r--README51
1 files changed, 51 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..73fda36
--- /dev/null
+++ b/README
@@ -0,0 +1,51 @@
+This is the top-level of the MicroMonitor source tree.
+
+There are three main directories:
+umon_main:
+ This is the common code reusable on various targets as the core
+ of MicroMonitor's functionality.
+umon_ports:
+ This directory contains the public ports of MicroMonitor. Each
+ subdirectory contains the makefile and target-specific code for
+ one uMon port.
+umon_apps:
+ This code provides a few different application examples for use
+ after the bootmonitor is built and running on your target. The
+ best place to go there is umon_apps/demo. This directory contains
+ the source and makefile that support building a basic application
+ for any target supported by MicroMonitor.
+
+For a quick introduction refer to:
+ http://www.umonfw.com/docs/white_paper.pdf
+For a lot more than you'll ever care to read about it refer to:
+ http://www.umonfw.com/docs/umon_user_manual.pdf
+OR...
+
+To get started, refer to umon_main/README.
+
+-----------------------------------------------------------------------
+
+Re-release of Micromonitor (aka uMon) under the Apache 2.0 license...
+
+Starting with the original umon1.19 code I referred to
+
+http://www.apache.org/dev/apply-license.html#new
+
+to do what was necessary to re-release a new smaller version of the
+uMon code under the Apache 2.0 license. This was originally motivated
+by a request from a GSOC (Google Summer of Code) student wanting to
+port uMon to the BeagleBone Black board as an alternative bootloader
+for use by the RTEMS embedded operating system.
+
+I copied http://www.apache.org/licenses/LICENSE-2.0.txt
+to this local LICENSE file.
+
+I started with https://www.apache.org/licenses/example-NOTICE.txt
+to create an appropriate NOTICE file.
+
+This README file was last modified on Mar 28, 2015.
+
+Primary contact:
+Ed Sutter ed.sutter@alcatel-lucent.com
+
+-----------------------------------------------------------------------