source: trunk/README @ 903

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

updated README about plplot and how to build without it.

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