source: branches/replacing_gnuplot/README @ 937

Last change on this file since 937 was 845, checked in by Jari Häkkinen, 12 years ago

Merged trunk changes -r782:844 to replacing_gnuplot branch.

  • 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: 4.4 KB
RevLine 
[84]1$Id: README 845 2009-11-16 22:27:19Z jari $
[26]2
[336]3= About svndigest =
4
[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.
[84]9
[281]10See the file NEWS for the user-visible changes from previous releases.
11In addition, there have been bugs fixed.
[84]12
[281]13svndigest is free software. See the file COPYING for copying conditions.
[84]14
[466]15Directory `bin` contains main program and is location for svndigest
[845]16binary. Directory `m4` contains additional autotool macros
[646]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).
[84]21
[590]22
[336]23== Downloading ==
[221]24
[281]25svndigest can be obtained from
[185]26
[784]27  http://dev.thep.lu.se/svndigest/wiki/DownloadPage
[221]28
29
[336]30== Documentation ==
[185]31
[281]32For documentation see the file doc/readme.txt.
[185]33
[26]34
[590]35== Requirements ==
36
37 * Subversion development files, i.e., header files and program
38   libraries, version 1.4 or later.
39
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.
44
[786]45 * PLplot, http://plplot.sourceforge.net, and pkg-config utility,
46   http://pkg-config.freedesktop.org, to query infomration about
47   PLplot headers and libs.
[590]48
49 * A standard C++ compliant compiler with one extension: svndigest
50   must be compiled with a C++ compiler that supports 'long long'
51   types - GCC does this. This requirement arises from the fact that
52   one of the underlying libraries, APR, is using 'long long'. APR is
53   written in C and the C standard allows 'long long'.
54   Even though the source is compiled with the -pedantic flag (which
55   should catch the non C++ standard 'long long') there is another
56   flag to suppress 'long long' diagnostics, -Wno-long-long.
57
58
59== Installing svndigest ==
60
61In file INSTALL you'll find the generic FSF install instructions. To
62compile and install svndigest you can follow the usual autotools path:
63
64 * `./configure`
65
66 * `make`
67
68 * Optionally, `make check` to run test programs. Some test programs
69   are not enabled by default and the disabled tests should only be
70   run by developers.
71
72 * `make install`
73
74The `./configure` script accepts a few options of interest for
75svndigest. You can provide `./configure` with APR and subversion API
76location information with `--with-apr=DIR` and `--with-svn=DIR`,
[784]77respectively.
[590]78
79If you grabbed the source from the subversion repository you need to
80run `./bootstrap` to setup autotools files (see README.developer).
81
82
[336]83== Development ==
[281]84
85The development of svndigest can be monitored through
86
[784]87  http://dev.thep.lu.se/svndigest
[281]88
89You can find most information concerning the development of svndigest at
90this site.
91
92
[336]93== Bug Reporting ==
[281]94
95You can report svndigest bugs on
96
[784]97  http://dev.thep.lu.se/svndigest/newticket
[281]98
[336]99Use user `svndigest` and password `svndigest`.
[281]100
101
[336]102== Subversion Access ==
[281]103
104The svndigest source repository is available via anonymous subversion
[386]105access, issue:
[281]106
[784]107  `svn checkout http://dev.thep.lu.se/svndigest/svn/trunk svndigest`
[281]108
[386]109See file README.developer for developer specific information. We make no
[281]110guarantees about the contents or quality of the latest code in the
111subversion repository: it is not unheard of for code that is known to
[386]112be broken to be committed to the repository. Use at your own risk.
[281]113
114
[336]115----------------------------------------------------------------------
[337]116{{{
[281]117Copyright (C) 2005, 2006 Jari Häkkinen
[845]118Copyright (C) 2007, 2008, 2009 Jari Häkkinen, Peter Johansson
[136]119
[784]120This file is part of svndigest, http://dev.thep.lu.se/svndigest
[136]121
[281]122svndigest is free software; you can redistribute it and/or modify it
123under the terms of the GNU General Public License as published by the
[784]124Free Software Foundation; either version 3 of the License, or (at your
[281]125option) any later version.
[136]126
[281]127svndigest is distributed in the hope that it will be useful, but
128WITHOUT ANY WARRANTY; without even the implied warranty of
129MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
130General Public License for more details.
[136]131
[281]132You should have received a copy of the GNU General Public License
[784]133along with svndigest. If not, see <http://www.gnu.org/licenses/>.
[337]134}}}
Note: See TracBrowser for help on using the repository browser.