c453ed4cd03ef0225f74cc93f204f79198dfdc4c
[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  build-essential (libc6-dev, gcc, g++, make)
44  automake, autoconf (if building from SVN)
45  mingw32
46  nsis
47  stow
48  unzip
49  texinfo
50  imagemagick
51  tetex-bin
52  tetex-extra
53  latex-xcolor (for the compendium)
54  tr
55  gs-common
56  hyperlatex
57  sharutils (uudecode for claws icon patch)
58  gettext (msgfmt, dcgettext, gmsgfmt, xgettext for glib)
59  libglib2.0-dev (glib-genmarshal for glib)
60
61
62 Building the Webpages
63 =====================
64
65 This has not been automated.  See the README file in the doc/website
66 directory.  To build the HTML version of the manuals you need to go to
67 doc/manual-de, run the command "make webversion" and copy the require
68 files to the desired location.  If you are a developer with write
69 access to the Sibversion, you may use the "online" target to actually
70 update the website.
71
72 Development Branches
73 ====================
74
75 The old version of gpg4win (version < 1.2) is since 1.1.3 tracked by
76 the SVN branch: branches/gpg4win-1-branch.  Only important fixes will
77 go into this version.  The current version is in the SVN trunk starts
78 as version 1.9 and will soon lead to version 2.0.
79
80
81
82 Adding new packages to the installer:
83 =====================================
84
85 This requires editing a couple of files; we might eventually automate
86 some of these tasks.  Here is a short run up:
87
88 1. Add constants for the package FOO into include/config.nsi.in .
89
90 2. Create 2 new installer scripts, named src/inst-foo.nsi and
91    uninst-foo.nsi and add them to EXTRA_DIST in src/Makefile.am.
92
93 3. Add foo to one the variables gpg4win_bpgks (if foo should not be
94    build be the gpg4win) or gpg4win_spkgs (if foo should be build by
95    gpg4win) in src/Makefile.am .  Also add any required configure
96    flags etc.
97
98 4. Add FOO to inst-sections.nsi.
99
100 5. Add detection of packages to configure.ac.  Check out the available
101    macros in m4/gpg4win.m4.  Depending on the way an upstream package
102    is packaged, you might need to write a new macro.
103
104 6. Add download information to packages/download.sh.
105
106 7. If the package ships pkg-config (*.pc) support files, you need add
107    post install instructions to Makefile.am.  Note that *.pc files may
108    be in the "runtime" directory ${pkgidir} if the package is built
109    within gpg4win (or peculiarly shipped), or in the development
110    package ${pkgidir_dev}.
111
112 Then run the usual "./autogen.sh" to create the actual configure file
113 and run configure as described above.
114
115
116 Copyright
117 =========
118
119 The entire Gpg4win package is
120
121   Copyright (C) 2005, 2006, 2007, 2008 g10 Code GmbH
122   
123   GPG4Win is free software; you can redistribute it and/or modify it
124   under the terms of the GNU General Public License as published by
125   the Free Software Foundation; either version 2 of the License, or
126   (at your option) any later version.
127   
128   GPG4Win is distributed in the hope that it will be useful, but
129   WITHOUT ANY WARRANTY; without even the implied warranty of
130   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
131   General Public License for more details.
132   
133   You should have received a copy of the GNU General Public License
134   along with this program; if not, write to the Free Software
135   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
136   02110-1301, USA
137
138
139 This file
140 =========
141
142 Copyright 2005, 2006, 2008 g10 Code GmbH
143
144 This file is free software; as a special exception the author gives
145 unlimited permission to copy and/or distribute it, with or without
146 modifications, as long as this notice is preserved.
147
148 This file is distributed in the hope that it will be useful, but
149 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
150 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
151 PURPOSE.