post release updates.
[gpg4win.git] / README
1 This is gpg4win - the GUI Installer Builder for W32.
2
3 Instructions:
4 =============
5
6 1. Download the source and binary packages that are required to build
7    the installer:
8
9    $ cd packages
10    $ sh download.sh
11    [...]
12    $ cd ..
13
14 2. Configure the source tree for cross compilation:
15
16    $ configure --host=i586-mingw32msvc
17
18 3. Build the installer:
19
20    $ make
21
22 The installer will be made available in two files:
23
24 src/gpg4win-X.Y.Z.exe
25 src/gpg4win-src-X.Y.Z.exe
26
27
28 Adding new packages to the installer:
29 =====================================
30
31 This requires editing a couple of files; we might eventually automate
32 some of tehse tasks.  Here is a short run up:
33
34 1. Add constants for the package FOO into include/config.nsi.in .
35
36 2. Create 2 new installer scripts, named src/inst-foo.nsi and
37    uninst-foo.nsi .
38
39 3. Add foo to one the variables gpg4win_bpgks (if foo should not be
40    build be the gpg4win) or gpg4win_spkgs (if foo should be build by
41    gpg4win) in src/Makefile.am
42
43 4. Add FOO to inst-sections.nsi and installer-finish.nsi.  The latter
44    is required for menu shortcuts.
45
46 5. Add detection of packages to configure.ac.  Check out the available
47    macros in m4/gpg4win.m4.  Depending on the way an upstream package
48    is packaged, you might need to write a new macro.
49
50 6. Add download information to packages/download.sh.
51
52 Then run the usual "./autogen.sh" to create the actual configure file
53 and run configure as described above.
54
55
56 Copyright 2005 g10 Code GmbH
57
58 This file is free software; as a special exception the author gives
59 unlimited permission to copy and/or distribute it, with or without
60 modifications, as long as this notice is preserved.
61
62 This file is distributed in the hope that it will be useful, but
63 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
64 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
65 PURPOSE.