[project @ 2003-07-24 15:12:35 by simonmar]
[ghc-hetmet.git] / ghc / README
index ea726df..b1831ee 100644 (file)
@@ -1,78 +1,53 @@
-This is version 2.01 of the Glorious Glasgow Haskell compilation
-system (GHC).  This is a major public release.  The top-level file
-"ANNOUNCE-0.28" says more.
+The Glasgow Haskell Compiler
+============================
 
 
-Haskell is "the" standard lazy functional programming language [see
-SIGPLAN Notices, May 1992]. Some general merits of GHC are given at
-the end of this file.
+(this file is fptools/ghc/README in a source distribution, and
+fptools/README in a binary distribution).
 
 
-Documentation of interest:
+GHC is a batch compiler for Haskell 98.  See the file ANNOUNCE for
+information on the current version.
 
 
-* docs/install_guide/installing.{dvi,info,html}: How to configure,
-  build, and install the system.
+Haskell is "the" standard lazy functional programming language.
+Haskell 98 is the current version of the language, released in
+December 1998.  The language definition is on the Web at
+http://www.haskell.org/definition/.
 
 
-  The document, as with many others, is in TeX-produced DVI format
-  (.dvi suffix), or GNU Info format (.info); the latter is close to
-  plain ASCII, if that's what you want.
+More information on GHC can be found on its web page
 
 
-* docs/users_guide/user.{dvi,info,html}: How to use GHC; e.g., what
-  options are available, how to cope with common problems, how to use
-  the profiling facilities, etc.
+       http://www.haskell.org/ghc/
 
 
-* docs/release_notes/release{dvi,info,html}: Release notes for this
-  release (and all previous releases).
+Documentation
+=============
 
 
-* docs/README: About the other documentation in this release.
+In a binary distribution, pre-formatted documentation can be found in
+the html and ps directories.  Pre-formatted HTML documentation is also
+available on the GHC web page.
+
+In a source distribution, the unformatted (SGML) documentation is in
+the following places:
+
+  * fptools/ghc/docs/users_guide  Users' Guide.
+  * fptools/hslibs/doc/hslibs    Library documentation.
+  * fptools/docs                 Build System Guide.
 
 We welcome your comments and suggestions about this software!  Please
 do not suffer or grumble in silence.  The "bug reports" section of the
 
 We welcome your comments and suggestions about this software!  Please
 do not suffer or grumble in silence.  The "bug reports" section of the
-User's Guide (docs/users_guide/user.{dvi,info,html}) says what we
-would like to know when you report a problem.
-
-Current AQUA team (all @dcs.glasgow.ac.uk):
-
-    Sigbjorn Finne     (sof)       [PhD student]
-    Andy Gill          (andy)      [PhD student]
-    Kevin Hammond      (kh)        [GRASP; now a research fellow]
-    Simon Marlow       (simonm)    [PhD student]
-    Darren Moffat      (moffatd)   [slave, summer '95]
-    Will Partain       (partain)   [hired hand, GRASP/AQUA]
-    Simon Peyton Jones (simonpj)   [our Fearless Leader]
-    Patrick Sansom     (sansom)    [hired hand, "Bidirectional Analyses"]
-    Andr\'e Santos     (andre)     [PhD student]
-
-Past contributors and/or continuing advisors:
-    Cordy Hall         (cvh)       [GRASP; now at Open University]
-    John Launchbury    (jl)        [AQUA; now at OGI]
-    Jim Mattson                (mattson)   [hired hand, AQUA; just moved to HP]
-    Bryan O'Sullivan   (bos)       [visiting slave, summer '94; at Sun]
-    Alastair Reid      (areid)     [GHCI god, now working at Yale]
-    Phil Wadler                (wadler)    [GRASP]
-
-Cool people who've let us use their machines:
-    hppa1.1-hp-hpux    Sam Nelson, Stirling University
-    mips-sgi-irix5     Tim Niblett, Turing Institute, Glasgow
-    sparc-sun-solaris2 Durham University
-
-Simon's projects' acronyms:
-    GRIP  ('87-'90): Graph reduction in parallel
-    GRASP ('90-'92): Graph reduction applications support project
-    AQUA  ('93-   ): Declarative systems architecture: a quantitative approach
-
-Dated: 95/07/24
-
-GHC WWW page: http://www.dcs.glasgow.ac.uk/fp/software/ghc.html
-
-E-mail contacts:
-    glasgow-haskell-request@dcs.glasgow.ac.uk   (general queries)
-
-    glasgow-haskell-bugs@dcs.glasgow.ac.uk     (bug reports mailing list)
-    glasgow-haskell-users@dcs.glasgow.ac.uk    (users' mailing list)
-
-    glasgow-haskell-bugs-request@...           to join, send mail *here*
-    glasgow-haskell-users-request@...          to join, send mail *here*
-
-Anonymous FTP site: ftp.dcs.glasgow.ac.uk:pub/haskell/glasgow.  Mostly
-mirrored by ftp.cs.chalmers.se and nebula.cs.yale.edu (same
-directory).  Also: src.doc.ic.ac.uk, in
-computing/programming/languages/haskell/glasgow/.
+User's Guide says what we would like to know when you report a
+problem.
+
+Mailing Lists
+=============
+
+    glasgow-haskell-bugs@haskell.org    (bug reports mailing list)
+    glasgow-haskell-users@haskell.org   (users' mailing list)
+    cvs-ghc@haskell.org                         (developers & bleeding-edge users list)
+
+    subscribe at http://www.haskell.org/mailman/listinfo/
+
+Contributors
+=============
+
+Please see
+  
+   http://www.haskell.org/ghc/contributors.html
+