source: trunk/README @ 906

Last change on this file since 906 was 906, checked in by Peter Johansson, 12 years ago

removed sub-heading optional from README and mention --with-plplot along with --with-apr and --with-svn

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