source: trunk/README @ 809

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

correcting text on where m4 files are located. Also removed version number to avoid maintainence for RM

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