source: trunk/README @ 199

Last change on this file since 199 was 185, checked in by Jari Häkkinen, 15 years ago

Fixes #65 and #60. Added support for svndigest:ignore. Uppdated documentation. Reworked binary file treatment.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.9 KB
Line 
1$Id: README 185 2006-09-06 02:39:18Z jari $
2
3======================================================================
4Copyright (C) 2005, 2006 Jari Häkkinen
5
6This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest
7
8svndigest is free software; you can redistribute it and/or modify it
9under the terms of the GNU General Public License as published by the
10Free Software Foundation; either version 2 of the License, or (at your
11option) any later version.
12
13svndigest is distributed in the hope that it will be useful, but
14WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16General Public License for more details.
17
18You should have received a copy of the GNU General Public License
19along with this program; if not, write to the Free Software
20Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
21USA.
22======================================================================
23
24
250  What is svndigest?
26
27svndigest is a tool to extract development information and statistics
28from a subversion repository. A slightly more detailed explanation is
29available in doc/readme.txt
30
31
321  Prerequisites
33
34ia) Subversion development files, i.e., header files and program
35   libraries, version 1.4 or later.
36
37ib) This item should not be an issue if item ia) is fulfilled; the
38   Apache Portable Runtime (APR) should be available if the subversion
39   API was succesfully compiled. Subversion depends on APR and in
40   consequence, the dependency is inherited by svndigest.
41
42ii) Gnuplot.
43
44iii) A standard C++ compliant compiler with one extension: svndigest
45   must be compiled with a C++ compiler that supports 'long long'
46   types - GCC does this. This is due to the fact that one of the
47   underlying libraries, APR, is using 'long long'. APR is written in
48   C and the C standard allows 'long long'.
49
50   Even though the source is compiled with the -pedantic flag (which
51   should catch the non C++ standard 'long long') there is another
52   flag to suppress 'long long' diagnostics, -Wno-long-long.
53
54
552  Compilation and installation
56
57See INSTALL for instructions on how to compile and install svndigest.
58
59
603  Running svndigest
61
62To get a listing of available options issue 'svndigest -h'. Simply run
63the program with
64
65   svndigest -r /path/to/a/subversion/WC -t /path/whereto/write/output -v
66
67The -v option will produce some output to stdout and can be omitted.
68
69
704  Acknowledgements
71
72svndigest uses a C++ interface to Gnuplot inspired by Rajarshi Guha.
73
74Rajarshi Guha's "A C++ Interface to Gnuplot" can be found through
75http://jijo.cjb.net/ . The C++ interface is based on "gnuplot
76interfaces in ANSI C" written by Nicolas Devillard. The C implemention
77is available through http://ndevilla.free.fr/ .
78
79svndigest build system uses an M4 macro (build_support/find_apr.m4)
80created within the Apache project (The Apache Software Foundation). No
81changes is made to the M4 script. The apache license text is available
82as buid_support/apache_LICENSE-2.0.txt.
Note: See TracBrowser for help on using the repository browser.