add missing abs brackets in equation
[haskell-report.git] / README
1 Haskell Report README
2 ~~~~~~~~~~~~~~~~~~~~~
3
4 These are the sources to the Haskell report, including all the source
5 files you will need to generate either the PDF or the HTML version of
6 the report.
7
8
9 Tools you will need
10 ~~~~~~~~~~~~~~~~~~~
11
12 PDF version: a decent LaTeX installation with pdflatex.  We use the
13 following additional packages:
14
15   - times
16   - makeidx
17   - graphicx
18   - url
19   - color
20   - hyperref
21
22 Also you need the following tools
23
24   - makeindex
25
26 all of which are usually available with a good TeX distribution
27 (e.g. TeX Live).
28
29 The following are also required for building the tools:
30
31   - flex
32   - GHC
33
34 The HTML version additionall requires
35
36   - tex4ht (e.g. install 'tex4ht' on a Debian or Ubuntu system, or 
37             'tetex-tex4ht' on a Fedora system)
38
39 Building the report
40 ~~~~~~~~~~~~~~~~~~~
41
42 Firstly:
43
44         $ cd tools
45         $ make
46
47 should build a few tools required for building the report itself.
48 Then you should be able to say
49
50         $ cd report
51         $ make
52
53 This will create:
54
55    - PDF version: report/haskell.pdf
56    
57    - HTML version: report/ht/haskell.html
58      (NB. requires report/ht/*.{html,png,css})
59
60
61 Roadmap
62 ~~~~~~~
63
64 SOURCE FILES
65
66     report/             The Language and Libraries Reports (now together
67                         in a single document)
68     
69     tools/              Tools needed to build the Reports
70                         (cd into here and type make)
71     
72     Makefile            Build a distribution of the Reports
73
74
75 .verb files
76 ~~~~~~~~~~~
77
78