Add second git reference to README file.
[packages/hoopl.git] / src / README
1 This is Hoopl, a higher-order optimization library.
2 There are two unpublished papers describing Hoopl:
3
4   Hoopl: Dataflow Optimization Made Simple
5   Hoopl: A Modular, Reusable Library for Dataflow Analysis and Transformation
6
7 The second such paper is attached to this package.
8
9 The version number is split into four parts:
10
11   3.   Third major body plan (phylum)
12   7.   Seventh iteration (roughly) of data structures
13   2.   Major version; changes when clients must change
14   1.   Minor version; changes when clients can stay the same
15
16
17 Version 3.7.3.3 has fixed known bugs.
18
19 Version 3.7.8.0 will be the last version uploaded to Hackage for some time.
20 This library is undergoing *very* rapid development, and we ask that you
21 get the most recent version from our public git repository:
22
23   git clone -o tufts git://ghc.cs.tufts.edu/hoopl/hoopl.git
24
25 If you are not familiar with git, we recommend the tutorial 'Git Magic'
26 by Ben Lynn.  To get some ideas about how to use git effectively,
27
28   http://whygitisbetterthanx.com/ 
29
30 is also useful.
31