[project @ 2002-09-18 06:34:07 by mthomas]
[ghc-hetmet.git] / ghc / README
index 2b0eb7d..24dec93 100644 (file)
@@ -1,47 +1,79 @@
-This is version 2.09 of the Glorious Glasgow Haskell compilation
-system (GHC).  GHC 2.09 is a compiler for Haskell 1.4.
+The Glasgow Haskell Compiler
+============================
+
+(this file is fptools/ghc/README in a source distribution, and
+fptools/README in a binary distribution).
+
+GHC is a batch compiler for Haskell 98.  See the file ANNOUNCE for
+information on the current version.
 
 Haskell is "the" standard lazy functional programming language.
 
 Haskell is "the" standard lazy functional programming language.
-Haskell 1.4 is the current version of the language, released in
-May. 1996.  The language definition is on the Web at
-http://haskell.cs.yale.edu/haskell-report/haskell-report.html
+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/.
 
 
-GHC documentation of interest:
+More information on GHC can be found on its web page
 
 
-* docs/installing.{dvi,info,html}: How to configure, build, and
-  install the system.
+       http://www.haskell.org/ghc/
 
 
-  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.
+Documentation
+=============
 
 
-* ghc/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.
+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.
 
 
-* ghc/docs/users_guide/release.{dvi,info,html}: Release notes for this
-  release (and earlier releases).
+In a source distribution, the unformatted (SGML) documentation is in
+the following places:
 
 
-* ghc/docs/README: About the other documentation in this release.
+  * 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.
+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
+=============
+
+Current GHC team:
+
+    Simon Peyton Jones <simonpj@microsoft.com>     [our Fearless Leader]
+    Simon Marlow       <simonmar@microsoft.com>    [hired hand]
+    Julian Seward       <v-julsew@microsoft.com>    [hired hand]
+    Reuben Thomas      <v-reubth@microsoft.com>    [hired hand]
+
+Additional Contributors (in alphabetical order):
+
+    Manuel Chakravarty   <chak@cse.unsw.edu.au>
+    Sigbjorn Finne      <sof@galois.com>
+    Kevin Glynn                 <keving@cs.mu.oz.au>
+    Jeff Lewis          <lewie@galois.com>
+    Marcin Kowalczyk    <qrczak@knm.org.pl>
+    Hans Wolfgang Lloidl <hwloidl@cee.hw.ac.uk>
+    Sven Panne          <Sven_Panne@BetaResearch.de>
+    Ken Shan            <ken@digitas.harvard.edu>
+    Keith Wansborough    <Keith.Wansbrough@cl.cam.ac.uk>
+    Michael Weber       <michael.weber@post.rwth-aachen.de>
 
 
-Current AQUA team (all @dcs.gla.ac.uk):
+Past contributors and/or continuing advisors (all @dcs.gla.ac.uk):
 
 
-    Sigbjorn Finne     (sof)       [PhD student]
-    Hans Wolfgang Loidl (hwloidl)   [PhD student]
-    Simon Marlow       (simonm)    [hired hand]
+    Juan Quintela       (quintela)
     Thomas Nordin       (nordin)    [@cse.ogi.edu; Green Card Hero]
     Thomas Nordin       (nordin)    [@cse.ogi.edu; Green Card Hero]
-    Simon Peyton Jones (simonpj)   [our Fearless Leader]
     Patrick Sansom     (sansom)    [hired hand, Bidirectional Analyses]
     Phil Trinder       (trinder)   [hired hand, Parade]
     Patrick Sansom     (sansom)    [hired hand, Bidirectional Analyses]
     Phil Trinder       (trinder)   [hired hand, Parade]
-
-Past contributors and/or continuing advisors:
-
-    Andy Gill          (andy)      [PhD student; at HP]
+    Andy Gill          (andy)      [ex-PhD student; at Galois]
     Cordy Hall         (cvh)       [GRASP]
     Kevin Hammond      (kh)        [GRASP; at St. Andrews]
     John Launchbury    (jl)        [AQUA; at OGI]
     Cordy Hall         (cvh)       [GRASP]
     Kevin Hammond      (kh)        [GRASP; at St. Andrews]
     John Launchbury    (jl)        [AQUA; at OGI]
@@ -49,11 +81,13 @@ Past contributors and/or continuing advisors:
     Darren Moffat      (moffatd)   [slave, summer '95; at MoD]
     Will Partain       (partain)   [GRASP/AQUA; touring with Johnny Cash]
     Bryan O'Sullivan   (bos)       [visiting slave, summer '94; at Sun]
     Darren Moffat      (moffatd)   [slave, summer '95; at MoD]
     Will Partain       (partain)   [GRASP/AQUA; touring with Johnny Cash]
     Bryan O'Sullivan   (bos)       [visiting slave, summer '94; at Sun]
-    Alastair Reid      (areid)     [GHCI god, at Yale]
+    Alastair Reid      (areid)     [GHCI, STG/Hugs etc.]
     Andr\'e Santos     (andre)     [PhD student; back in Brazil]
     David N Turner     (dnt)       [Linear Types; at An-Teallach]
     Phil Wadler                (wadler)    [GRASP; at Lucent]
 
     Andr\'e Santos     (andre)     [PhD student; back in Brazil]
     David N Turner     (dnt)       [Linear Types; at An-Teallach]
     Phil Wadler                (wadler)    [GRASP; at Lucent]
 
+And many others who've contributed bits of code / bug reports in the past.
+
 Cool people who've let us use their machines:
 
     sparc-sun-sunos{4,5}   PacSoft, Oregon Graduate Institute
 Cool people who've let us use their machines:
 
     sparc-sun-sunos{4,5}   PacSoft, Oregon Graduate Institute
@@ -69,21 +103,3 @@ 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
     GRIP  ('87-'90): Graph reduction in parallel
     GRASP ('90-'92): Graph reduction applications support project
     AQUA  ('93-   ): Declarative systems architecture: a quantitative approach
-
-Dated: 97/03
-
-GHC WWW page: http://www.dcs.gla.ac.uk/fp/software/ghc.html
-
-E-mail contacts:
-    glasgow-haskell-request@dcs.gla.ac.uk   (admin & general queries)
-
-    glasgow-haskell-bugs@dcs.gla.ac.uk     (bug reports mailing list)
-    glasgow-haskell-users@dcs.gla.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.gla.ac.uk:pub/haskell/glasgow.  Mostly
-mirrored by ftp.cs.chalmers.se and haskell.cs.yale.edu (same
-directory).  Also: src.doc.ic.ac.uk, in
-computing/programming/languages/haskell/glasgow/.