README: Added just another dependency that sometimes happen to miss.
[gpg4win.git] / README
1 This is gpg4win - the GUI Installer Builder for W32.
2
3
4 Instructions:
5 =============
6
7 1. Download the source and binary packages that are required to build
8    the installer:
9
10    $ cd packages
11    $ sh download.sh
12    [...]
13    $ cd ..
14
15    If you have downloaded gnupg-2.x, you need to rename that tarball.
16    e.g.:
17    
18      mv gnupg-2.0.5.tar.bz2 gnupg2-2.0.5.tar.bz2
19
20 2. Configure the source tree for cross compilation:
21
22    $ configure --host=i586-mingw32msvc
23
24 3. Build the installer:
25
26    $ make
27
28 The installer will be made available in two files:
29
30 src/gpg4win-X.Y.Z.exe
31 src/gpg4win-src-X.Y.Z.exe
32
33
34 Basic requirements
35 ==================
36
37 A decent POSIX system is required for building this software as well
38 as GNU make.  We are using Debian GNU/Linux (Sid), however it should
39 work with current Testing (as of Februar 2006) too.  It might work with
40 Sarge - this has not been tested.  To satisfy all needs of configure
41 at least the following packages need to be installed:
42
43  mingw32
44  nsis
45  stow
46  unzip
47  texinfo
48  imagemagick
49  tetex-bin
50  tetex-extra
51  tr
52  gs-common
53  hyperlatex
54  libglib2.0-dev
55
56
57 Building the Webpages
58 =====================
59
60 This has not been automated.  See the README file in the doc/website
61 directory.  To build the HTML version of the manuals you need to go to
62 doc/manual-de, run the command "make webversion" and copy the require
63 files to the desired location.  If you are a developer with write
64 access to the Sibversion, you may use the "online" target to actually
65 update the website.
66
67
68 Adding new packages to the installer:
69 =====================================
70
71 This requires editing a couple of files; we might eventually automate
72 some of these tasks.  Here is a short run up:
73
74 1. Add constants for the package FOO into include/config.nsi.in .
75
76 2. Create 2 new installer scripts, named src/inst-foo.nsi and
77    uninst-foo.nsi .
78
79 3. Add foo to one the variables gpg4win_bpgks (if foo should not be
80    build be the gpg4win) or gpg4win_spkgs (if foo should be build by
81    gpg4win) in src/Makefile.am
82
83 4. Add FOO to inst-sections.nsi.
84
85 5. Add detection of packages to configure.ac.  Check out the available
86    macros in m4/gpg4win.m4.  Depending on the way an upstream package
87    is packaged, you might need to write a new macro.
88
89 6. Add download information to packages/download.sh.
90
91 Then run the usual "./autogen.sh" to create the actual configure file
92 and run configure as described above.
93
94
95 Copyright
96 =========
97
98 The entire Gpg4win package is
99
100   Copyright (C) 2005, 2006, 2007 g10 Code GmbH
101   
102   GPG4Win is free software; you can redistribute it and/or modify it
103   under the terms of the GNU General Public License as published by
104   the Free Software Foundation; either version 2 of the License, or
105   (at your option) any later version.
106   
107   GPG4Win is distributed in the hope that it will be useful, but
108   WITHOUT ANY WARRANTY; without even the implied warranty of
109   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
110   General Public License for more details.
111   
112   You should have received a copy of the GNU General Public License
113   along with this program; if not, write to the Free Software
114   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
115   02110-1301, USA
116
117
118 This file
119 =========
120
121 Copyright 2005, 2006 g10 Code GmbH
122
123 This file is free software; as a special exception the author gives
124 unlimited permission to copy and/or distribute it, with or without
125 modifications, as long as this notice is preserved.
126
127 This file is distributed in the hope that it will be useful, but
128 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
129 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
130 PURPOSE.