summaryrefslogtreecommitdiffstats
path: root/testsuites/samples/README
diff options
context:
space:
mode:
Diffstat (limited to 'testsuites/samples/README')
-rw-r--r--testsuites/samples/README71
1 files changed, 71 insertions, 0 deletions
diff --git a/testsuites/samples/README b/testsuites/samples/README
new file mode 100644
index 0000000000..77a734193f
--- /dev/null
+++ b/testsuites/samples/README
@@ -0,0 +1,71 @@
+#
+# COPYRIGHT (c) 1989, 1990, 1991, 1992, 1993, 1994.
+# On-Line Applications Research Corporation (OAR).
+# All rights assigned to U.S. Government, 1994.
+#
+# This material may be reproduced by or for the U.S. Government pursuant
+# to the copyright license under the clause at DFARS 252.227-7013. This
+# notice must appear in all copies of this file and its derivatives.
+#
+
+This directory contains the RTEMS Sample Application Suite.
+The tests in this directory perform two functions:
+
+ + provide simple examples of applications which can be
+ used as a starting point for your application.
+
+ + help test a new board support package
+
+The hello and ticker applications are useful when first bringing up
+a new board support package. The base_mp test is useful when
+performing initial checkout on a new MPCI layer.
+
+The following describes each of the sample applications:
+
+ base_mp
+
+ This is a very simple two node multiprocessor application. It consists
+ of a single initialization task on each node which print out
+ their respective node numbers and task IDs. This test can be
+ used as a simple test of a new MPCI layer because it minimizes
+ the number of packets sent by RTEMS.
+
+ This is intended as a starting point for custom developed multiprocessor
+ applications.
+
+ base_sp
+
+ This is a simple single processor application which consists of
+ an initialization task which creates another task.
+
+ This is intended as a starting point for custom developed single
+ processor applications.
+
+ cdtest
+
+ A very simple C++ application which demonstrates that it is
+ possible to use C++ contructors and destructors in an RTEMS
+ application. Also does a perfunctory iostream test.
+
+ hello
+
+ This is the RTEMS version of the classic hello world program.
+ It consists of single initialization task which prints out
+ a few messages.
+
+ This test does not include a Clock Tick device driver and can
+ be used to test the startup code of the board support package
+ as well as console output.
+
+ paranoia
+
+ A public domain test of the floating point and math library
+ capabilities of a toolset. It reports discrepancies between
+ actual and expected results. It is a large test.
+
+ ticker
+
+ This is a simple test of the user's Clock Tick device driver.
+ This test has an initialization task create three application
+ tasks which sleep and periodically wake up and print the time.
+