Prepare dph for a vectInfoVar type change
[packages/dph.git] / README
diff --git a/README b/README
index 6ac6cb9..b54d41f 100644 (file)
--- a/README
+++ b/README
@@ -4,6 +4,12 @@ Directories in libraries/dph
    dph-base/
         Common config and debugging functions for Data Parallel Haskell.
 
+   dph-buildbot/
+        Performance regression buildbot.
+
+   dph-examples/
+        Examples using Data Parallel Haskell.
+
    dph-prim-interface/
         Empty implementation of flat parallel arrays. 
         This package exists only so that dph-prim-par and dph-prim-seq
@@ -12,7 +18,7 @@ Directories in libraries/dph
    dph-prim-seq/
         Sequential implementation of the flat parallel array API defined
         in dph-prim-interface.
-        This is normal only used during debugging.
+        This is only used during debugging.
         You probably want dph-prim-par instead.
 
    dph-prim-par/
@@ -22,6 +28,7 @@ Directories in libraries/dph
    dph-lifted-base/
         Common definitions used by the other dph-lifted packages.
 
+
    The following packages provide:
      Nested arrays and the primitive operators that work on them (PA functions).
      The lifted array combinators that the vectoriser introduces (PP functions).
@@ -29,7 +36,7 @@ Directories in libraries/dph
 
      dph-lifted-boxed/
         Incomplete implementation using boxed array elements.
-        This is very slow, but sometimes useful during debugging.
+        This is very slow, but sometimes useful for debugging.
         
      dph-lifted-copy/
         Deprecated implementation that performs deep copying replicate.
@@ -43,6 +50,21 @@ Directories in libraries/dph
         Use this version for production code.
 
 
+   Odds and ends:
+   make/
+        Makefiles used for development and debugging
+
+   dph-test/
+        Quickcheck tests for the array operators.
+
+   dtrace/
+        Old code to add dtrace support to DPH.
+
+   examples/
+        Rotted example code that doesn't build anymore and should 
+        probably just be deleted.
+    
+
 To compile programs use:
      ghc -rtsopts -threaded 
          -fllvm -optlo-O3 
@@ -69,3 +91,4 @@ Why:
                                 --  The implementation of the DPH backend library should
                                 --  manually handle most cases where LiberateCase
                                 --  would fire.
+