fix Haskell 98 reference
[haskell-report.git] / README
1 Notes on building the report
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3
4 Tools needed: 
5       
6       * flex
7       * GHC
8       * TeX (install "tetex" on a Linux distribution to get everything
9         you need).
10
11 Firstly:
12
13         $ cd tools
14         $ make
15
16 should build a few tools required for building the report itself.
17 Then you should be able to say
18
19         $ cd report
20         $ make
21
22 to build the PS (haskell.ps) and HTML (in haskell-report-html)
23 versions.  To get PDF, use ps2pdf on the PS version.
24
25 When you check in a patch to the darcs repo, darcs will automatically
26 try to re-build the tools and report.  If it fails for any reason, then
27 your patch will be rejected.  (This is controlled by the top-level
28 Makefile target 'default', and the darcs preferences.)  If you think
29 your patch is fine, but the build system is broken, then you might need
30 to login to darcs.haskell.org and do some fixing by hand.
31
32 [
33   There are various other Makefile rules; for example 'make release' at
34   the top level was supposed to build a complete release of the "Revised
35   Haskell 98 Report", although it doesn't work out of the box.  For
36   Haskell', we'll want to modify these Makefiles to do what we want in
37   due course.
38 ]
39
40
41 Roadmap
42 ~~~~~~~
43
44 SOURCE FILES
45
46     report/             The Language and Libraries Reports (now together
47                         in a single document)
48     
49     libraries/          OUT OF DATE (from Dec 2002): ignore this directory
50     
51     tools/              Tools needed to build the Reports
52                         (cd into here and type make)
53     
54     Makefile            Build a distribution of the Reports
55
56     report/haskell-prime-draft.html     A summary page to glue all the outputs together
57
58     report/h98.gif      A GIF for a Haskell 98 logo
59     report/hprime.png   A PNG for a Haskell Prime logo
60
61
62 OUTPUT FILES
63     haskell-prime-draft/        A directory containing the distribution
64     haskell-report-html/        A directory containing the HTML
65
66