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