source: trunk/README @ 631

Last change on this file since 631 was 612, checked in by Jari Häkkinen, 14 years ago

build_support info was out of date.

  • 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.6 KB
RevLine 
[84]1$Id: README 612 2008-04-22 12:43:21Z jari $
[26]2
[336]3= About svndigest =
4
[467]5This directory contains the 0.7 release of svndigest.
[84]6
[281]7svndigest is a tool to extract development information and statistics
[590]8from a subversion repository.  Svndigest is written in C++ and
9extracts repository history using the subversion API. The resulting
10report is written to a user specifiable directory in HTML format.
[84]11
[281]12See the file NEWS for the user-visible changes from previous releases.
13In addition, there have been bugs fixed.
[84]14
[281]15svndigest is free software. See the file COPYING for copying conditions.
[84]16
[466]17Directory `bin` contains main program and is location for svndigest
[612]18binary. Directory `build_support` contains additional autotool macros
19required for creating the build environment. Directory `doc` contains
20documentation mainly in file `readme.txt`. Most of the code can be
21found in directory `lib`. Directory `test` contains the code for tests
22and the test repository (see README.developer).
[84]23
[590]24
[336]25== Downloading ==
[221]26
[281]27svndigest can be obtained from
[185]28
[519]29  http://trac.thep.lu.se/svndigest/wiki/DownloadPage
[221]30
31
[336]32== Documentation ==
[185]33
[281]34For documentation see the file doc/readme.txt.
[185]35
[26]36
[590]37== Requirements ==
38
39 * Subversion development files, i.e., header files and program
40   libraries, version 1.4 or later.
41
42 * This item should not be an issue if item above is fulfilled; the
43   Apache Portable Runtime (APR) should be available if the subversion
44   API was successfully compiled. Subversion depends on APR and in
45   consequence, the dependency is inherited by svndigest.
46
47 * Gnuplot.
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`,
77respectively. `--enable-staticbin` will create a static
78svndigest binary. (Actually as static as the underlying program
79libraries allows it to be, i.e., some external libraries might not
80have been created/installed in static versions.)
81
82If you grabbed the source from the subversion repository you need to
83run `./bootstrap` to setup autotools files (see README.developer).
84
85
[336]86== Development ==
[281]87
88The development of svndigest can be monitored through
89
[519]90  http://trac.thep.lu.se/svndigest
[281]91
92You can find most information concerning the development of svndigest at
93this site.
94
95
[336]96== Bug Reporting ==
[281]97
98You can report svndigest bugs on
99
[519]100  http://trac.thep.lu.se/svndigest/newticket
[281]101
[336]102Use user `svndigest` and password `svndigest`.
[281]103
104
[336]105== Subversion Access ==
[281]106
107The svndigest source repository is available via anonymous subversion
[386]108access, issue:
[281]109
[337]110  `svn checkout http://lev.thep.lu.se/repository/svndigest/trunk svndigest`
[281]111
[386]112See file README.developer for developer specific information. We make no
[281]113guarantees about the contents or quality of the latest code in the
114subversion repository: it is not unheard of for code that is known to
[386]115be broken to be committed to the repository. Use at your own risk.
[281]116
117
[336]118----------------------------------------------------------------------
[337]119{{{
[281]120Copyright (C) 2005, 2006 Jari Häkkinen
[408]121Copyright (C) 2007 Jari Häkkinen, Peter Johansson
[590]122Copyright (C) 2008 Jari Häkkinen
[136]123
[519]124This file is part of svndigest, http://trac.thep.lu.se/svndigest
[136]125
[281]126svndigest is free software; you can redistribute it and/or modify it
127under the terms of the GNU General Public License as published by the
128Free Software Foundation; either version 2 of the License, or (at your
129option) any later version.
[136]130
[281]131svndigest is distributed in the hope that it will be useful, but
132WITHOUT ANY WARRANTY; without even the implied warranty of
133MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
134General Public License for more details.
[136]135
[281]136You should have received a copy of the GNU General Public License
137along with this program; if not, write to the Free Software
138Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
139USA.
[337]140}}}
[185]141
142
Note: See TracBrowser for help on using the repository browser.