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