source: trunk/README @ 590

$Id: README 590 2008-04-12 18:20:32Z jari $

= About svndigest =

This directory contains the 0.7 release of svndigest.

svndigest is a tool to extract development information and statistics
from a subversion repository.  Svndigest is written in C++ and
extracts repository history using the subversion API. The resulting
report is written to a user specifiable directory in HTML format.

See the file NEWS for the user-visible changes from previous releases.
In addition, there have been bugs fixed.

svndigest is free software. See the file COPYING for copying conditions.

Directory `bin` contains main program and is location for svndigest
binary. Directory `build_support` contains an autotool macro that is
used to find APR location. Directory `doc` contains documentation
mainly in file `readme.txt`. Most of the code can be found in
directory `lib`. Directory `test` contains the code for tests and the
test repository (see README.developer).


== Downloading ==

svndigest can be obtained from 

  http://trac.thep.lu.se/svndigest/wiki/DownloadPage


== Documentation ==

For documentation see the file doc/readme.txt.


== Requirements ==

 * Subversion development files, i.e., header files and program
   libraries, version 1.4 or later.

 * This item should not be an issue if item above is fulfilled; the
   Apache Portable Runtime (APR) should be available if the subversion
   API was successfully compiled. Subversion depends on APR and in
   consequence, the dependency is inherited by svndigest.

 * Gnuplot.

 * A standard C++ compliant compiler with one extension: svndigest
   must be compiled with a C++ compiler that supports 'long long'
   types - GCC does this. This requirement arises from the fact that
   one of the underlying libraries, APR, is using 'long long'. APR is
   written in C and the C standard allows 'long long'.
   Even though the source is compiled with the -pedantic flag (which
   should catch the non C++ standard 'long long') there is another
   flag to suppress 'long long' diagnostics, -Wno-long-long.


== Installing svndigest ==

In file INSTALL you'll find the generic FSF install instructions. To
compile and install svndigest you can follow the usual autotools path:

 * `./configure`

 * `make`

 * Optionally, `make check` to run test programs. Some test programs
   are not enabled by default and the disabled tests should only be
   run by developers.

 * `make install`

The `./configure` script accepts a few options of interest for
svndigest. You can provide `./configure` with APR and subversion API
location information with `--with-apr=DIR` and `--with-svn=DIR`,
respectively. `--enable-staticbin` will create a static
svndigest binary. (Actually as static as the underlying program
libraries allows it to be, i.e., some external libraries might not
have been created/installed in static versions.) 

If you grabbed the source from the subversion repository you need to
run `./bootstrap` to setup autotools files (see README.developer).


== Development ==

The development of svndigest can be monitored through 

  http://trac.thep.lu.se/svndigest

You can find most information concerning the development of svndigest at
this site.


== Bug Reporting ==

You can report svndigest bugs on 

  http://trac.thep.lu.se/svndigest/newticket

Use user `svndigest` and password `svndigest`.


== Subversion Access ==

The svndigest source repository is available via anonymous subversion
access, issue:

  `svn checkout http://lev.thep.lu.se/repository/svndigest/trunk svndigest`

See file README.developer for developer specific information. We make no
guarantees about the contents or quality of the latest code in the
subversion repository: it is not unheard of for code that is known to
be broken to be committed to the repository. Use at your own risk.


----------------------------------------------------------------------
{{{
Copyright (C) 2005, 2006 Jari Häkkinen
Copyright (C) 2007 Jari Häkkinen, Peter Johansson
Copyright (C) 2008 Jari Häkkinen

This file is part of svndigest, http://trac.thep.lu.se/svndigest

svndigest is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

svndigest is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
USA.
}}}