README

Code
Comments
Other
Rev Date Author Line
84 13 Mar 06 jari 1 $Id$
26 05 Jan 06 jari 2
336 19 May 07 peter 3 = About svndigest =
336 19 May 07 peter 4
281 06 May 07 peter 5 svndigest is a tool to extract development information and statistics
590 12 Apr 08 jari 6 from a subversion repository.  Svndigest is written in C++ and
590 12 Apr 08 jari 7 extracts repository history using the subversion API. The resulting
590 12 Apr 08 jari 8 report is written to a user specifiable directory in HTML format.
84 13 Mar 06 jari 9
281 06 May 07 peter 10 See the file NEWS for the user-visible changes from previous releases.
281 06 May 07 peter 11 In addition, there have been bugs fixed.
84 13 Mar 06 jari 12
281 06 May 07 peter 13 svndigest is free software. See the file COPYING for copying conditions.
84 13 Mar 06 jari 14
466 30 Aug 07 peter 15 Directory `bin` contains main program and is location for svndigest
806 12 Jul 09 peter 16 binary. Directory `m4` contains additional autotool macros
612 22 Apr 08 jari 17 required for creating the build environment. Directory `doc` contains
612 22 Apr 08 jari 18 documentation mainly in file `readme.txt`. Most of the code can be
612 22 Apr 08 jari 19 found in directory `lib`. Directory `test` contains the code for tests
612 22 Apr 08 jari 20 and the test repository (see README.developer).
84 13 Mar 06 jari 21
590 12 Apr 08 jari 22
336 19 May 07 peter 23 == Downloading ==
221 25 Dec 06 jari 24
281 06 May 07 peter 25 svndigest can be obtained from 
185 06 Sep 06 jari 26
1182 25 Aug 10 peter 27    https://sourceforge.net/projects/svndigest/files/
221 25 Dec 06 jari 28
221 25 Dec 06 jari 29
336 19 May 07 peter 30 == Documentation ==
185 06 Sep 06 jari 31
281 06 May 07 peter 32 For documentation see the file doc/readme.txt.
185 06 Sep 06 jari 33
26 05 Jan 06 jari 34
590 12 Apr 08 jari 35 == Requirements ==
590 12 Apr 08 jari 36
590 12 Apr 08 jari 37  * Subversion development files, i.e., header files and program
1610 11 Feb 23 peter 38    libraries, version 1.9 or later.
590 12 Apr 08 jari 39
590 12 Apr 08 jari 40  * This item should not be an issue if item above is fulfilled; the
590 12 Apr 08 jari 41    Apache Portable Runtime (APR) should be available if the subversion
590 12 Apr 08 jari 42    API was successfully compiled. Subversion depends on APR and in
590 12 Apr 08 jari 43    consequence, the dependency is inherited by svndigest.
590 12 Apr 08 jari 44
1677 30 Aug 23 peter 45  * yat, https://sourceforge.net/projects/libyat, 0.12 (or newer) is
1677 30 Aug 23 peter 46    required. It is possible to build against a yat that has been
1677 30 Aug 23 peter 47    configured with '--withot-htslib'.
1673 26 Aug 23 peter 48
1573 06 Feb 15 jari 49  * PLplot, http://plplot.sourceforge.net, version 5.10.0 (or newer) is
1182 25 Aug 10 peter 50    required to generate graphics in the output. You can build
1182 25 Aug 10 peter 51    svndigest without PLplot if you run configure with
1182 25 Aug 10 peter 52    `--without-plplot`. If you output plots in PNG format, it is
1182 25 Aug 10 peter 53    recommended to install plplot with pngcairo or pngqt devices.
906 28 Nov 09 peter 54
906 28 Nov 09 peter 55  * pkg-config utility, http://pkg-config.freedesktop.org, is used to
906 28 Nov 09 peter 56    query information about PLplot headers and libs. It is possible to
906 28 Nov 09 peter 57    configure and build without pkg-config, but we recommend that you
906 28 Nov 09 peter 58    have pkg-config available because it makes detection of PLplot much
906 28 Nov 09 peter 59    more automatic and convenient.
906 28 Nov 09 peter 60
1652 14 Jun 23 peter 61  * A standard C++11 compliant compiler is required.
590 12 Apr 08 jari 62
590 12 Apr 08 jari 63 == Installing svndigest ==
590 12 Apr 08 jari 64
590 12 Apr 08 jari 65 In file INSTALL you'll find the generic FSF install instructions. To
590 12 Apr 08 jari 66 compile and install svndigest you can follow the usual autotools path:
590 12 Apr 08 jari 67
590 12 Apr 08 jari 68  * `./configure`
590 12 Apr 08 jari 69
590 12 Apr 08 jari 70  * `make`
590 12 Apr 08 jari 71
590 12 Apr 08 jari 72  * Optionally, `make check` to run test programs. Some test programs
590 12 Apr 08 jari 73    are not enabled by default and the disabled tests should only be
590 12 Apr 08 jari 74    run by developers.
590 12 Apr 08 jari 75
590 12 Apr 08 jari 76  * `make install`
590 12 Apr 08 jari 77
590 12 Apr 08 jari 78 The `./configure` script accepts a few options of interest for
906 28 Nov 09 peter 79 svndigest. You can provide `./configure` with APR, subversion, and
906 28 Nov 09 peter 80 PLplot API location information with `--with-apr=DIR`,
906 28 Nov 09 peter 81 `--with-svn=DIR`, and `--with-plplot=DIR, respectively.
590 12 Apr 08 jari 82
590 12 Apr 08 jari 83 If you grabbed the source from the subversion repository you need to
590 12 Apr 08 jari 84 run `./bootstrap` to setup autotools files (see README.developer).
590 12 Apr 08 jari 85
590 12 Apr 08 jari 86
336 19 May 07 peter 87 == Development ==
281 06 May 07 peter 88
281 06 May 07 peter 89 The development of svndigest can be monitored through 
281 06 May 07 peter 90
687 04 Aug 08 peter 91   http://dev.thep.lu.se/svndigest
281 06 May 07 peter 92
281 06 May 07 peter 93 You can find most information concerning the development of svndigest at
281 06 May 07 peter 94 this site.
281 06 May 07 peter 95
281 06 May 07 peter 96
336 19 May 07 peter 97 == Bug Reporting ==
281 06 May 07 peter 98
281 06 May 07 peter 99 You can report svndigest bugs on 
281 06 May 07 peter 100
687 04 Aug 08 peter 101   http://dev.thep.lu.se/svndigest/newticket
281 06 May 07 peter 102
1182 25 Aug 10 peter 103 Use user `svndigest` and password `svndigest`. For more details please
1182 25 Aug 10 peter 104 refer to section 'Reporting failures' in file `test/README`.
281 06 May 07 peter 105
281 06 May 07 peter 106
336 19 May 07 peter 107 == Subversion Access ==
281 06 May 07 peter 108
281 06 May 07 peter 109 The svndigest source repository is available via anonymous subversion
386 24 Jun 07 jari 110 access, issue:
281 06 May 07 peter 111
694 14 Sep 08 jari 112   `svn checkout http://dev.thep.lu.se/svndigest/svn/trunk svndigest`
281 06 May 07 peter 113
386 24 Jun 07 jari 114 See file README.developer for developer specific information. We make no
281 06 May 07 peter 115 guarantees about the contents or quality of the latest code in the
281 06 May 07 peter 116 subversion repository: it is not unheard of for code that is known to
386 24 Jun 07 jari 117 be broken to be committed to the repository. Use at your own risk.
281 06 May 07 peter 118
281 06 May 07 peter 119
336 19 May 07 peter 120 ----------------------------------------------------------------------
337 19 May 07 peter 121 {{{
978 12 Dec 09 peter 122 Copyright (C) 2005, 2006 Jari Häkkinen
978 12 Dec 09 peter 123 Copyright (C) 2007, 2008, 2009 Jari Häkkinen, Peter Johansson
1182 25 Aug 10 peter 124 Copyright (C) 2010 Peter Johansson
1573 06 Feb 15 jari 125 Copyright (C) 2015 Jari Häkkinen
1635 30 Mar 23 peter 126 Copyright (C) 2023 Peter Johansson
136 03 Aug 06 jari 127
687 04 Aug 08 peter 128 This file is part of svndigest, http://dev.thep.lu.se/svndigest
136 03 Aug 06 jari 129
281 06 May 07 peter 130 svndigest is free software; you can redistribute it and/or modify it
281 06 May 07 peter 131 under the terms of the GNU General Public License as published by the
693 11 Sep 08 jari 132 Free Software Foundation; either version 3 of the License, or (at your
281 06 May 07 peter 133 option) any later version.
136 03 Aug 06 jari 134
281 06 May 07 peter 135 svndigest is distributed in the hope that it will be useful, but
281 06 May 07 peter 136 WITHOUT ANY WARRANTY; without even the implied warranty of
281 06 May 07 peter 137 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
281 06 May 07 peter 138 General Public License for more details.
136 03 Aug 06 jari 139
281 06 May 07 peter 140 You should have received a copy of the GNU General Public License
693 11 Sep 08 jari 141 along with svndigest. If not, see <http://www.gnu.org/licenses/>.
337 19 May 07 peter 142 }}}

Generated on Wed Aug 30 02:20:48 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)