44573d8f23cb91a7e9bd5e6f3fdc378cc7e1bd84
[zfs.git] / zfs / lib / libumem / README-alpha
1 This is the libumem package.
2 This document describes the actions needed to build the pre-release
3 or CVS version of the package. See end of file for copying conditions.
4
5 * Introduction
6
7     This is a *pre-release* version, and not ready for production use
8 yet. If you are taking source from CVS, you will need to have libtool,
9 automake, and autoconf installed to help contribute. See the chapter
10 `Building' for the detailed instructions. The script autogen.sh is
11 provided to help autoconfigure libumem from the cvs src.  After you
12 run autogen.sh, there should be a file 'INSTALL' with (generic)
13 installation instructions. Package-specific installation instructions
14 are set forth in the file README.
15
16     Please, note that the accompanying documentation may be inaccurate
17 or incomplete. The CVS history is the authoritative documentation of
18 all recent changes.
19
20 Report bugs to (TODO: mailing list <>)
21
22 * Checking Out the Sources
23
24 The following instructions apply if you wish to obtain sources from
25 the CVS repository:
26
27 To checkout the source tree from CVS issue the following command:
28
29   cvs -z3 -d:pserver:anonymous@umem.cvs.sourceforge.net:/cvsroot/umem co \
30     -P umem
31
32     This will give you read-only access.  If you think you need write access,
33 contact the mailing list.
34
35 * Building
36
37     In order to build this you will first need to have right versions
38 of autotools and some auxiliary GNU programs. At the time of this
39 writing these are: 
40
41   Package   Version (>=)
42   ========  ============
43   automake  1.4
44   autoconf  2.50
45   libtool   1.5.0
46   
47     To prepare the package for building run autogen.sh. Then run
48 ./configure with the desired options (See INSTALL and README for the
49 detailed instructions). Finally, run make. Notice that the first make
50 of the package should be made in the source directory. Subsequent
51 makes can use build directory different from the source one.
52
53 * Copyright information:
54
55 Please see COPYRIGHT and OPENSOLARIS.LICENSE for the copyright
56 and license details.