[project @ 1996-01-08 20:13:28 by partain]
[nofib.git] / README
1 This is the root directory of the "NoFib Haskell benchmark suite";
2 version 0.26 (to match our other Glasgow functional-programming
3 tools).
4
5 We have yet to release the NoFib stuff as we intended -- everything
6 tidied up -- because it's a lot of work for very few brownie points.
7 As it is, however, it is quite useful as a Haskell-compiler test
8 suite, so we are not keeping it to ourselves.
9
10 This version has *MANY* shortcomings, some of which I hope you will
11 report, so we can get something "real" out the door.
12
13 There are some restrictions on the use of this software.  First of
14 all, the copyright for the individual programs remains with their
15 authors (unless they have explicitly said otherwise).  Second, we (the
16 AQUA project at University of Glasgow) retain the copyright to any
17 changes made to the programs *and* to the collection of programs
18 itself.  Third, for this "not-0.26" non-release, it would be dishonest
19 to suggest that any results are related to the still-in-the-future
20 "NoFib benchmark suite".  So please do not make any such claims.
21
22 A position paper about the suite is in docs/paper/paper.dvi, and it
23 includes more than enough indication as to how we intend this suite to
24 be used.  Of course, we positively *welcome* honest and creative uses
25 of this suite.
26
27 The file BUILDING provides some direction about setting up the suite,
28 in order to run it. [NOTE: doesn't exist yet; see sketchy notes below]
29
30 The file BUGS is a list of things we *know* are not right [ALSO
31 VIRTUALLY USELESS].  Help would be most welcome...
32
33 You may sent comments or bug reports about this suite either to me
34 (partain@dcs.glasgow.ac.uk) or (glasgow-haskell-bugs@dcs.glasgow.ac.uk).
35 They will be most welcome.
36
37 Will Partain
38
39 == SKETCHY NOTES ==================================================
40
41 Quick and dirty
42 ~~~~~~~~~~~~~~~
43
44 Find a program you are interested in, make up a "makefile" by hand,
45 and try it :-)
46
47
48 Doing things properly
49 ~~~~~~~~~~~~~~~~~~~~~
50
51 * Run: ./configure --enable-nofib --disable-ghc --with-hc={ghc*,glhc*,hbc*,nhc*}
52
53 * Your "mkworld" project id is "nofib" (surprise, surprise).  You must
54   also pick a "setup" for your "nofib project".
55
56   There are three available, one per compiler tried so far: hbc, ghc,
57   and nhc.
58
59 * Once you've decided on a setup, edit
60   nofib/mkworld/site-nofib-<setup>.jm.  "SetupHcOpts" should be set to
61   the compiler options that should be applied absolutely always (if
62   any).
63   
64   nofib/mkworld/site-nofib-hbc.jm is a nice simple example.
65
66 * You should be ready to go.  "cd" to the very top directory and type:
67
68     sh < STARTUP
69
70   This should configure and build the mkworld, literate, and
71   glafp-utils infrastructure, and configure the nofib stuff itself.
72
73 * If that works -- and you'll know if it did -- then do:
74
75     % cd nofib
76     % make -k >& make.log # to compile everything; save log for study
77     % make -k runtests >& runtests.log  # also for study