Update build-deps
[jigdo.git] / README
1
2 Jigsaw Download (jigdo)
3 ~~~~~~~~~~~~~~~~~~~~~~~
4
5 See the doc/ directory for documentation - start with the HOWTO
6 for an introduction to jigdo.
7
8 Debian CD images via jigdo:            <http://www.debian.org/CD/jigdo-cd/>
9 Current Jigdo homepage:                <https://www.einval.com/~steve/software/jigdo/>
10 Current maintainer:    Steve McIntyre  <steve@einval.com>
11
12 Original Jigsaw Download homepage:     <http://atterer.org/jigdo/>
13 Originally written by Richard Atterer: <richard@atterer.org>
14
15 ----------------------------------------------------------------------
16
17 To build the programs, execute:
18     ./configure && make
19
20 (If no file named "configure" is present in this directory, you have
21 downloaded a jigdo git snapshot. Have a look at the "bootstrapping"
22 section in doc/Hacking.txt.)
23
24 After a successful build, you can install the program (by default into
25 /usr/local) with
26
27    make install
28
29 To build Debian packages (.deb) from the sources, execute:
30     deb/rules
31
32 To build an RPM package (.rpm) from the sources, execute:
33     rpmbuild -ta jigdo-x.y.z.tar.bz2
34
35 To build a .tar.bz2 with docs and statically linked binaries, execute:
36     ./configure && make bindist
37
38 Apart from the usual options (see "./configure --help"), the configure
39 script also recognizes the following options:
40   --without-libdb         Don't use libdb3 (it's necessary for jigdo-file's cache)
41   --with-gui              Build the jigdo GTK+ GUI application [auto]
42   --with-uint64=TYPE      Specify unsigned type of at least 64 bits [auto]
43                           (Replace spaces with underscores in TYPE)
44   --disable-nls           Disable multi-language support
45   --enable-debug          Compile in lots of additional debugging code
46   --disable-libwww-hacks  Don't compile fixed versions of some libwww
47                           code (Try this if you see link errors/crashes)
48
49 ----------------------------------------------------------------------
50
51 Authors:
52
53 Richard Atterer was the main jigdo author.
54 Other contributors:
55
56 - Paul Bolle made the jigdo.spec (based on an earlier version by Alexander
57   Skwar)
58 - Peter Jay Salzman <p dirac.org> maintains the Debian jigdo mini HOWTO
59 - Jochen Hepp <jochen.hepp gmx.de>: jigdo-file patches
60 - Anne Bezemer <J.A.Bezemer opensourcepartners.nl>:
61   Some code snippets in the jigdo-lite script
62 - Steve McIntyre took over maintenance after Richard, and added:
63   New v2 format using SHA256
64   Various bugfixes
65
66 jigdo uses some code written by other people:
67
68 - Free Software Foundation, Inc.:
69   Library routines. [Files: glibc-*]
70 - James Henstdridge <james at daa.com.au>:
71   Code for integration of glib and libwww. [Files: glibwww-*]
72 - Damon Chaplin <damon at helixcode.com> and
73   Martijn van Beers <martijn at earthling.net>:
74   Support code for the GUI, generated by Glade. [File: gtk-support.cc]
75
76 ----------------------------------------------------------------------
77
78 Copyright (C) 2001-2010  |  richard@
79 Richard Atterer          |  atterer.org
80 Copyright (C) 2016-2019 Steve McIntyre <steve@einval.com>
81
82
83   This program is free software; you can redistribute it and/or modify
84   it under the terms of the GNU General Public License, version 2, as
85   published by the Free Software Foundation.
86
87   This program is distributed in the hope that it will be useful, but
88   WITHOUT ANY WARRANTY; without even the implied warranty of
89   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
90   General Public License for more details.
91
92   In addition, as a special exception, the author gives permission to
93   link the jigdo code with the OpenSSL project's "OpenSSL" library (or
94   with modified versions of it that use the same license as the
95   "OpenSSL" library), and to distribute the linked executables. You
96   must obey the GNU General Public License in all respects for all of
97   the code used other than "OpenSSL". If you modify any jigdo source
98   file, you may extend this exception to your version of the file, but
99   you are not obliged to do so. If you do not wish to do so, delete
100   this exception statement from your version.
101
102 Please note: The copyright notice in the file COPYING only applies to
103 the text of the GNU General Public License; the copyright of the
104 individual source files is as specified at the top of each file and
105 above. Also note that the code is licensed under GPL _version_2_ and
106 no other version. Special licensing for my (RA's) code is available on
107 request.