initial checkout from wrc

1 files changed, 25 insertions, 0 deletions

diff --git a/user/README b/user/README
new file mode 100644
index 0000000..548aac4
--- /dev/null
+++ b/user/README
@@ -0,0 +1,25 @@
+This directory contains the source code for all user-level processes,
+split out by main function.
+
+Naming convention:
+
+    idle()      classic 'idle' process; ensures there is always a
+                runnable process to dispatch (vs., for instance, having
+                dispatch() pause when there is nothing to dispatch).
+
+    init()      classic 'init' process; starts the idle process, and
+                starts (and restarts) the user shell program.
+
+    shell()     "user shell" process, for spawning individual tests
+
+    progN()     program source code for user process(es) 'N'
+
+All of these expect at least one command-line argument.  All are invoked
+with command lines of this form:
+
+    name  x  n
+
+Each of these is designed to be compiled and linked separately, with the
+resulting load modules bundled into a blob for automatic loading by the
+bootstrap. Each will typically use one or more library functions from the
+../lib directory.