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