[MLton-commit] r5955

[Vesa Karvonen]

Minimal README.

----------------------------------------------------------------------

A   mltonlib/trunk/com/ssh/random/unstable/README

----------------------------------------------------------------------

Added: mltonlib/trunk/com/ssh/random/unstable/README
===================================================================
--- mltonlib/trunk/com/ssh/random/unstable/README	2007-08-25 21:40:10 UTC (rev 5954)
+++ mltonlib/trunk/com/ssh/random/unstable/README	2007-08-25 21:45:41 UTC (rev 5955)
@@ -0,0 +1,70 @@
+Random Generator Library
+------------------------
+
+   This library implements a framework for (functional) random generators.
+   The design is based on the QuickCheck [1] library by Koen Claessen and
+   John Hughes.
+
+
+Info
+----
+
+   License:         MLton license (a BSD-style license)
+   Portability:     portable (MLton and SML/NJ are supported)
+   Stability:       experimental
+   Maintainer:      Vesa Karvonen <vesa.a.j.k at gmail.com>
+
+
+About Library Organization
+--------------------------
+
+   public/
+
+      This directory contains the documented signature definitions (*.sig)
+      and listings of all top-level bindings exported by this library
+      (public/export.sml).  The contents of this directory should ideally
+      be sufficient to understand how to use the functionality provided by
+      this library.
+
+   example/
+
+      This directory contains examples related to this library.
+
+   lib.{cm,mlb}
+
+      These build files defines the library.
+
+   detail/
+
+      This directory contains the implementation details of the library.
+
+
+Contributions
+-------------
+
+   The signatures and structures defined by this library are not meant to
+   be cast in stone!  We welcome contributions including new features,
+   bug fixes, and ports to new compilers.  The recommended submit method
+   for small contributions to this library is to send a message with a
+   brief description of the proposed contribution as well as a patch
+   containing full code and documentation (signature comments) to either
+   the MLton-user list
+
+      mlton-user at mlton.org
+
+   or the MLton list
+
+      mlton at mlton.org .
+
+   For larger extensions or changes we recommend that you first contact
+   the active maintainer(s) of this library.  The preferred contact method
+   is through the above mailing lists.
+
+
+References
+----------
+
+  [1] QuickCheck: A Lightweight Tool for Random Testing of Haskell
+      Programs.
+      Koen Claessen and John Hughes.
+      ICFP 2000.