Remove gui/poll.tex
[haskell-report.git] / README
diff --git a/README b/README
index 0fff47a..b1d82a5 100644 (file)
--- a/README
+++ b/README
@@ -1,30 +1,78 @@
-       The Haskell Language and Library Reports
-       ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Haskell Report README
+~~~~~~~~~~~~~~~~~~~~~
+
+These are the sources to the Haskell report, including all the source
+files you will need to generate either the PDF or the HTML version of
+the report.
+
+
+Tools you will need
+~~~~~~~~~~~~~~~~~~~
+
+PDF version: a decent LaTeX installation with pdflatex.  We use the
+following additional packages:
+
+  - times
+  - makeidx
+  - graphicx
+  - url
+  - color
+  - hyperref
+
+Also you need the following tools
+
+  - makeindex
+
+all of which are usually available with a good TeX distribution
+(e.g. TeX Live).
+
+The following are also required for building the tools:
+
+  - flex
+  - GHC
+
+The HTML version additionall requires
+
+  - tex4ht (e.g. install 'tex4ht' on a Debian or Ubuntu system, or 
+            'tetex-tex4ht' on a Fedora system)
+
+Building the report
+~~~~~~~~~~~~~~~~~~~
+
+Firstly:
+
+        $ cd tools
+        $ make
+
+should build a few tools required for building the report itself.
+Then you should be able to say
+
+        $ cd report
+        $ make
+
+This will create:
+
+   - PDF version: report/haskell.pdf
+   
+   - HTML version: report/ht/haskell.html
+     (NB. requires report/ht/*.{html,png,css})
+
+
+Roadmap
+~~~~~~~
 
 SOURCE FILES
 
-    report/            The Language Report
-    
-    libraries/         The Libraries Report
+    report/            The Language and Libraries Reports (now together
+                       in a single document)
     
     tools/             Tools needed to build the Reports
                        (cd into here and type make)
     
     Makefile           Build a distribution of the Reports
 
-    haskell98-bugs.html        A list of all the changes from the original
-                       Haskell 98 Report to the July 2001 revision.
-                       Covers both the Language and Library report.
-    
-           
-    h98.gif            A GIF for a Haskell 98 logo
-
-
-OUTPUT FILES
-    haskell98-revised/ A directory containing the distribution
 
+.verb files
+~~~~~~~~~~~
 
-       Notes on how to generate PDF
-       ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-[Mark pls fill in here.]