[project @ 2001-11-19 18:53:50 by sof]
[ghc-hetmet.git] / ghc / README
index 8dfc890..822c986 100644 (file)
-This is version 2.01 of the Glorious Glasgow Haskell compilation
-system (GHC).  GHC 2.01 is a compiler for Haskell 1.3.
+The Glasgow Haskell Compiler
+============================
 
 
-2.01 is a full GHC release; however, as the first release of the 1.3
-compiler, it is "test" quality; it very well may have serious bugs.
-The top-level file "ANNOUNCE-2.01" says more.
+(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.3 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/install_guide/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
+=============
 
 
-* 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.
 
 
-* docs/release_notes/release{dvi,info,html}: Release notes for this
-  release (and all previous releases).
+In a source distribution, the unformatted (SGML) documentation is in
+the following places:
 
 
-* 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.
 
 
-Current AQUA team (all @dcs.gla.ac.uk):
+Mailing Lists
+=============
 
 
-    Sigbjorn Finne     (sof)       [PhD student]
-    Hans Wolfgang Loidl (hwloidl)   [PhD student]
-    Simon Marlow       (simonm)    [PhD student]
-    Will Partain       (partain)   [hired hand, GRASP/AQUA]
-    Simon Peyton Jones (simonpj)   [our Fearless Leader]
-    Patrick Sansom     (sansom)    [hired hand, Bidirectional Analyses]
-    Phil Trinder       (trinder)   [hired hand, Parade]
-    David N Turner     (dnt)       [hired hand, Linear Types]
+    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
+=============
 
 
-Past contributors and/or continuing advisors:
+Current GHC team:
 
 
-    Andy Gill          (andy)      [PhD student; at HP]
+    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@microsoft.com>
+    Kevin Glynn                 <keving@cs.mu.oz.au>
+    Jeff Lewis          <jlewis@cse.ogi.edu>
+    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>
+
+Past contributors and/or continuing advisors (all @dcs.gla.ac.uk):
+
+    Juan Quintela       (quintela)
+    Thomas Nordin       (nordin)    [@cse.ogi.edu; Green Card Hero]
+    Patrick Sansom     (sansom)    [hired hand, Bidirectional Analyses]
+    Phil Trinder       (trinder)   [hired hand, Parade]
+    Andy Gill          (andy)      [ex-PhD student; at OGI]
     Cordy Hall         (cvh)       [GRASP]
     Kevin Hammond      (kh)        [GRASP; at St. Andrews]
     John Launchbury    (jl)        [AQUA; at OGI]
     Jim Mattson                (mattson)   [hired hand, AQUA; HP]
     Darren Moffat      (moffatd)   [slave, summer '95; at MoD]
     Cordy Hall         (cvh)       [GRASP]
     Kevin Hammond      (kh)        [GRASP; at St. Andrews]
     John Launchbury    (jl)        [AQUA; at OGI]
     Jim Mattson                (mattson)   [hired hand, AQUA; HP]
     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]
     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]
     Andr\'e Santos     (andre)     [PhD student; back in Brazil]
-    Phil Wadler                (wadler)    [GRASP; at Lucent soon]
+    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:
 
 
 Cool people who've let us use their machines:
 
-    hppa1.1-hp-hpux    Sam Nelson, Stirling University
-    powerpc-ibm-aix    Walter Robinson, Mechanical Eng'g, Glasgow U.
+    sparc-sun-sunos{4,5}   PacSoft, Oregon Graduate Institute
+    hppa1.1-hp-hpux,
+    i386-unknown-linux    Charles Krasic, Oregon Graduate Institute
+    alpha-dec-osf,        
+    i386-*-solaris2        Mark Fanty, CSLU, Oregon Graduate Institute
+
+Also thanks to Conal Elliott, Microsoft Research for facilitating the work
+on the Win32 port of GHC.
 
 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
 
 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: 96/07
-
-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/.