monotone

monotone Mtn Source Tree

Root/README

1Monotone::AutomateStdio Version 0.09
2====================================
3
4This is a Perl library module for accessing Monotone's automate stdio
5interface. Monotone is a distributed, change-set, based VCS system. It has a
6mode where commands can be sent to it via STDIN and output read from it via
7STDOUT. Monontone::AutomateStdio makes use of this facility to provide the Perl
8programmer with a programmatic interface to Monotone.
9
10For further details on Monotone see http://monotone.ca. For further details on
11Monotone::AutomateStdio see http://www.coosoft.plus.com/software.html.
12
13
14INSTALLATION
15------------
16
17Simply unpack the tar file and use Makefile.PL by doing:
18
19 tar xvpzf Monotone-AutomateStdio-<Version Number>.tar.gz
20 cd Monotone-AutomateStdio-<Version Number>
21 perl Makefile.PL
22 make
23 make test
24 make install
25
26To install to a custom location use:
27
28 perl Makefile.PL PREFIX=<PATH>
29
30To configure the software to run in a custom location but have the installation
31location prepended by an additional path (useful for package maintainers) use:
32
33 perl Makefile.PL PREFIX=<PATH> DESTDIR=<PATH>
34
35Please note that automated testing of this library module is still `work in
36progress'. There is a test harness called mtn-tester that can be used to test
37most important features of this library. However, it does require not only the
38installation of Monotone, as you would expect, but also a test database with
39certain revisions and files in it. At the moment this is done by using a
40dedicated branch in the main Monotone database found at monotone.ca. The test
41branch is called net.venge.monotone.contrib.lib.automate-stdio.test.
42
43In time I hope to write a Monotone emulator that generates the required output
44to test the library, or perhaps just have a smaller database generated on the
45fly.
46
47
48DEPENDENCIES
49------------
50
51This module requires these other modules and libraries:
52
53 * Perl 5.8.5
54
55Older versions of Perl may work but these have not been tested at this point in
56time.
57
58
59COPYRIGHT AND LICENCE
60---------------------
61
62Copyright (c) 2007 Anthony Edward Cooper <aecooper@coosoft.plus.com>.
63
64This library is free software; you can redistribute it and/or modify it under
65the terms of the GNU Lesser General Public License as published by the Free
66Software Foundation; either version 3 of the License, or (at your option) any
67later version.
68
69This library is distributed in the hope that it will be useful, but WITHOUT ANY
70WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
71PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
72
73You should have received a copy of the GNU Lesser General Public License along
74with this library; if not, write to the Free Software Foundation, Inc., 59
75Temple Place - Suite 330, Boston, MA 02111-1307 USA.

Archive Download this file

Branches

Tags

Quick Links:     www.monotone.ca    -     Downloads    -     Documentation    -     Wiki    -     Code Forge    -     Build Status