[project @ 1997-09-03 23:15:02 by sof]
[nofib.git] / README
1 This is the root directory of the "NoFib Haskell benchmark suite";
2 version 2.05 (to match our other Glasgow functional-programming
3 tools).
4
5 The main change between version 2.01 and 2.05 is that the programs
6 have been converted to Haskell 1.4.
7
8 We have yet to release the NoFib stuff as we intended -- everything
9 tidied up -- because it's a lot of work for very few brownie points.
10 Probably we never will.  As it is, however, it is quite useful as a
11 Haskell-compiler test suite, so we are not keeping it to ourselves.
12
13 This version has *MANY* shortcomings, some of which I hope you will
14 report, so we can get something "real" out the door.
15
16 There are some restrictions on the use of this software.  First of
17 all, the copyright for the individual programs remains with their
18 authors (unless they have explicitly said otherwise).  Second, we (the
19 Glasgow Haskell project at University of Glasgow) retain the copyright
20 to any changes made to the programs *and* to the collection of
21 programs itself.  Third, for 2.05, it would be dishonest to suggest
22 that any results are related to the still-in-the-future "NoFib
23 benchmark suite".  So please do not make any such claims.
24
25 A position paper about the suite is in docs/paper/paper.dvi, and it
26 includes more than enough indication as to how we intend this suite to
27 be used.  Of course, we positively *welcome* honest and creative uses
28 of this suite.
29
30 The file BUILDING provides some direction about setting up the suite,
31 in order to run it. [NOTE: doesn't exist yet; see sketchy notes below]
32
33 You may sent comments or bug reports about this suite either to the
34 Glasgow Haskell bugs list <glasgow-haskell-bugs@dcs.gla.ac.uk>.
35 They will be most welcome.
36
37 == SKETCHY NOTES ==================================================
38
39 Quick and dirty
40 ~~~~~~~~~~~~~~~
41
42 Find a program you are interested in, make up a "makefile" by hand,
43 and try it :-)
44
45
46 Doing things properly
47 ~~~~~~~~~~~~~~~~~~~~~
48
49 * This version of nofib only supports ghc-2.05, so if you try to use
50   other versions of GHC or different Haskell systems, you're going to
51   run into some obstacles.
52
53 * Plop the nofib distribution inside the Glasgow fptools suite, i.e.,
54   unpack nofib at the toplevel at the same level as directories such as
55   ghc/ and glafp-utils/.
56
57 * Have a look in mk/config.mk.in to see what variables control the nofib setup.
58   If you want to change these, put the new settings for them in the build-specific
59   setup file, mk/build.mk
60
61 * Run ./configure
62
63 * Assuming you haven't built the compiler, you will need to do that first.
64   Type "make boot" (or whatever make is called on your system)
65   followed by "make all". 
66
67 * cd nofib/
68
69 * Ready the nofib suite for some use, by running `make boot', which
70   takes care of creating Makefile dependendencies.
71
72 * If all that worked -- and you'll know if it did -- then do:
73
74     % make -k >& make.log # to compile everything; save log for study
75     % make -k runtests >& runtests.log  # also for study