summaryrefslogtreecommitdiffstats
path: root/micromonitor/diagnostics/README
diff options
context:
space:
mode:
Diffstat (limited to 'micromonitor/diagnostics/README')
-rw-r--r--micromonitor/diagnostics/README16
1 files changed, 16 insertions, 0 deletions
diff --git a/micromonitor/diagnostics/README b/micromonitor/diagnostics/README
new file mode 100644
index 0000000..14f7f3f
--- /dev/null
+++ b/micromonitor/diagnostics/README
@@ -0,0 +1,16 @@
+#
+# $Id$
+#
+
+This is an example of a non-RTEMS diagnostics program built using
+MicroMonitor and the RTEMS tools. It isn't setup to auto-adapt
+to a new BSP. You will have to edit the makefile.
+
+This program reads a key from the user to indicate what the results
+of the "diagnostics" should (e.g. PASS, FAIL, or UNKNOWN). The
+MicroMonitor environment variable DIAGNOSTICS_RESULT is set to
+that value. This environment variable may be queried by MicroMonitor
+scripts and the RTEMS application.
+
+
+XXX insert script here