Add README to describe directory layout
authorSimon Peyton Jones <simonpj@microsoft.com>
Tue, 10 Jan 2012 10:47:05 +0000 (10:47 +0000)
committerSimon Peyton Jones <simonpj@microsoft.com>
Tue, 10 Jan 2012 10:47:05 +0000 (10:47 +0000)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..368e27d
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+Directories in libraries/dph
+
+   dph-lifted-boxed/  Inefficient reference model, no fusion
+   dph-lifted-copy/   Does fusion, but has the replicate problem
+   dph-lifted-vseg/   Cool new version
+
+   dph-lifted-base/   Common definitions used by all three above
+
+   dph-base/    ???? what is this ???
+
+   dph-prim-interface/  Interface to the unboxed-array implementation
+   dph-prim-seq/        Sequential implementation of dph-prim-interface
+   dph-prim-par/        Parallel implementation of dph-prim-interface
+
+
+A build includes
+  * One of {dph-lifted-boxed, dph-lifted-copy, dph-lifted-vseg}
+  * dph-lifted-base
+  * One of dph-prim-par, dph-prim-seq
+