source: trunk/README

Last change on this file was 1573, checked in by Jari Häkkinen, 6 years ago

Fixes #472. Removed workaround needed for plplot prior to 5.10.0

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-trac-wiki
File size: 5.0 KB
[84]1$Id: README 1573 2015-02-06 08:01:05Z jari $
[336]3= About svndigest =
[281]5svndigest is a tool to extract development information and statistics
[590]6from a subversion repository.  Svndigest is written in C++ and
7extracts repository history using the subversion API. The resulting
8report is written to a user specifiable directory in HTML format.
[281]10See the file NEWS for the user-visible changes from previous releases.
11In addition, there have been bugs fixed.
[281]13svndigest is free software. See the file COPYING for copying conditions.
[466]15Directory `bin` contains main program and is location for svndigest
[806]16binary. Directory `m4` contains additional autotool macros
[612]17required for creating the build environment. Directory `doc` contains
18documentation mainly in file `readme.txt`. Most of the code can be
19found in directory `lib`. Directory `test` contains the code for tests
20and the test repository (see README.developer).
[336]23== Downloading ==
[281]25svndigest can be obtained from
[336]30== Documentation ==
[281]32For documentation see the file doc/readme.txt.
[590]35== Requirements ==
37 * Subversion development files, i.e., header files and program
38   libraries, version 1.4 or later.
40 * This item should not be an issue if item above is fulfilled; the
41   Apache Portable Runtime (APR) should be available if the subversion
42   API was successfully compiled. Subversion depends on APR and in
43   consequence, the dependency is inherited by svndigest.
[1573]45 * PLplot,, version 5.10.0 (or newer) is
[1182]46   required to generate graphics in the output. You can build
47   svndigest without PLplot if you run configure with
48   `--without-plplot`. If you output plots in PNG format, it is
49   recommended to install plplot with pngcairo or pngqt devices.
51 * pkg-config utility,, is used to
52   query information about PLplot headers and libs. It is possible to
53   configure and build without pkg-config, but we recommend that you
54   have pkg-config available because it makes detection of PLplot much
55   more automatic and convenient.
[590]57 * A standard C++ compliant compiler with one extension: svndigest
58   must be compiled with a C++ compiler that supports 'long long'
59   types - GCC does this. This requirement arises from the fact that
60   one of the underlying libraries, APR, is using 'long long'. APR is
61   written in C and the C standard allows 'long long'.
62   Even though the source is compiled with the -pedantic flag (which
63   should catch the non C++ standard 'long long') there is another
64   flag to suppress 'long long' diagnostics, -Wno-long-long.
67== Installing svndigest ==
69In file INSTALL you'll find the generic FSF install instructions. To
70compile and install svndigest you can follow the usual autotools path:
72 * `./configure`
74 * `make`
76 * Optionally, `make check` to run test programs. Some test programs
77   are not enabled by default and the disabled tests should only be
78   run by developers.
80 * `make install`
82The `./configure` script accepts a few options of interest for
[906]83svndigest. You can provide `./configure` with APR, subversion, and
84PLplot API location information with `--with-apr=DIR`,
85`--with-svn=DIR`, and `--with-plplot=DIR, respectively.
87If you grabbed the source from the subversion repository you need to
88run `./bootstrap` to setup autotools files (see README.developer).
[336]91== Development ==
93The development of svndigest can be monitored through
97You can find most information concerning the development of svndigest at
98this site.
[336]101== Bug Reporting ==
103You can report svndigest bugs on
[1182]107Use user `svndigest` and password `svndigest`. For more details please
108refer to section 'Reporting failures' in file `test/README`.
[336]111== Subversion Access ==
113The svndigest source repository is available via anonymous subversion
[386]114access, issue:
[694]116  `svn checkout svndigest`
[386]118See file README.developer for developer specific information. We make no
[281]119guarantees about the contents or quality of the latest code in the
120subversion repository: it is not unheard of for code that is known to
[386]121be broken to be committed to the repository. Use at your own risk.
[978]126Copyright (C) 2005, 2006 Jari Häkkinen
127Copyright (C) 2007, 2008, 2009 Jari Häkkinen, Peter Johansson
[1182]128Copyright (C) 2010 Peter Johansson
[1573]129Copyright (C) 2015 Jari Häkkinen
[687]131This file is part of svndigest,
[281]133svndigest is free software; you can redistribute it and/or modify it
134under the terms of the GNU General Public License as published by the
[693]135Free Software Foundation; either version 3 of the License, or (at your
[281]136option) any later version.
[281]138svndigest is distributed in the hope that it will be useful, but
139WITHOUT ANY WARRANTY; without even the implied warranty of
141General Public License for more details.
[281]143You should have received a copy of the GNU General Public License
[693]144along with svndigest. If not, see <>.
Note: See TracBrowser for help on using the repository browser.