HTML versions of the manuals are now ready... kind of. Some images are too
[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.
56
57
58 Adding new packages to the installer:
59 =====================================
60
61 This requires editing a couple of files; we might eventually automate
62 some of these tasks.  Here is a short run up:
63
64 1. Add constants for the package FOO into include/config.nsi.in .
65
66 2. Create 2 new installer scripts, named src/inst-foo.nsi and
67    uninst-foo.nsi .
68
69 3. Add foo to one the variables gpg4win_bpgks (if foo should not be
70    build be the gpg4win) or gpg4win_spkgs (if foo should be build by
71    gpg4win) in src/Makefile.am
72
73 4. Add FOO to inst-sections.nsi.
74
75 5. Add detection of packages to configure.ac.  Check out the available
76    macros in m4/gpg4win.m4.  Depending on the way an upstream package
77    is packaged, you might need to write a new macro.
78
79 6. Add download information to packages/download.sh.
80
81 Then run the usual "./autogen.sh" to create the actual configure file
82 and run configure as described above.
83
84
85 Copyright
86 =========
87
88 The entire GPG4Win package is
89
90   Copyright (C) 2005, 2006 g10 Code GmbH
91   
92   GPG4Win is free software; you can redistribute it and/or modify it
93   under the terms of the GNU General Public License as published by
94   the Free Software Foundation; either version 2 of the License, or
95   (at your option) any later version.
96   
97   GPG4Win is distributed in the hope that it will be useful, but
98   WITHOUT ANY WARRANTY; without even the implied warranty of
99   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
100   General Public License for more details.
101   
102   You should have received a copy of the GNU General Public License
103   along with this program; if not, write to the Free Software
104   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
105   02110-1301, USA
106
107
108 This file
109 =========
110
111 Copyright 2005, 2006 g10 Code GmbH
112
113 This file is free software; as a special exception the author gives
114 unlimited permission to copy and/or distribute it, with or without
115 modifications, as long as this notice is preserved.
116
117 This file is distributed in the hope that it will be useful, but
118 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
119 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
120 PURPOSE.