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