Remove qt as a build dependency
[gpg4win.git] / README
1 This is gpg4win - the GUI Installer Builder for W32.
2
3 See also the file doc/README.en.txt.
4
5 Instructions:
6 =============
7
8 1. Download the source and binary packages that are required to build
9    the installer:
10
11    $ cd packages
12    $ sh download.sh
13    [...]
14    $ cd ..
15
16 2. Configure the source tree for cross compilation:
17
18    $ ./autogen.sh --build-w32
19
20 3. Build the installer:
21
22    $ make
23
24 The installer will be made available in three files:
25
26 src/gpg4win-X.Y.Z.exe
27 src/gpg4win-light-X.Y.Z.exe
28 src/gpg4win-src-X.Y.Z.exe
29
30
31 Basic requirements
32 ==================
33
34 A decent POSIX system is required for building this software as well
35 as GNU make.  We are using Debian GNU/Linux 8 (Jessie), any other
36 POSIX system should work as well but you may run into problems due to
37 different toolchain versions.
38
39 To satisfy all needs of configure at least the following packages need
40 to be installed:
41
42  build-essential (libc6-dev, gcc, g++, make)
43  automake, autoconf (if building from GIT)
44  mingw32
45  mingw-w64
46  mingw-w64-i686-dev
47  mingw-w64-x86-64-dev
48  nsis
49  stow
50  unzip
51  texinfo
52  imagemagick
53  gs-common | ghostscript (gs)
54  docbook-utils
55  gettext (msgfmt, dcgettext, gmsgfmt, xgettext for glib)
56  libglib2.0-dev (glib-genmarshal, glib-compile-{resources,schemas})
57  libgdk-pixbuf2.0-dev (gdk-pixbuf-csource)
58  texlive (you need most modules)
59  texlive-latex-extra
60  texlive-lang-german
61  latex-xcolor (for the compendium)
62  libgettextpo-dev
63
64
65 Building the Webpages
66 =====================
67
68 The website is in the dedicated branch "website" in the git reposity.
69 Checkout that branch and read the instructions:
70
71   git checkout website
72
73
74 Development Branches
75 ====================
76
77 The old version of gpg4win (version < 1.2) is since 1.1.3 tracked by
78 the GIT branch: gpg4win-1-branch.  Only important fixes will go into
79 this version.  The current version in the GIT master starts as version
80 1.9.
81
82
83
84 Adding new packages to the installer:
85 =====================================
86
87 This requires editing a couple of files; we might eventually automate
88 some of these tasks.  Here is a short run up:
89
90 1. Add constants for the package FOO into include/config.nsi.in .
91
92 2. Create 2 new installer scripts, named src/inst-foo.nsi and
93    uninst-foo.nsi and add them to EXTRA_DIST in src/Makefile.am.
94
95 3. Add foo to one the variables gpg4win_bpgks (if foo should not be
96    build be the gpg4win) or gpg4win_spkgs (if foo should be build by
97    gpg4win) in src/Makefile.am .  Also add any required configure
98    flags etc.
99
100 4. Add FOO to inst-sections.nsi.
101
102 5. Add detection of packages to configure.ac.  Check out the available
103    macros in m4/gpg4win.m4.  Depending on the way an upstream package
104    is packaged, you might need to write a new macro.
105
106 6. Add download information to packages/download.sh.
107
108 7. If the package ships pkg-config (*.pc) support files, you need add
109    post install instructions to Makefile.am.  Note that *.pc files may
110    be in the "runtime" directory ${pkgidir} if the package is built
111    within gpg4win (or peculiarly shipped), or in the development
112    package ${pkgidir_dev}.
113
114 Then run the usual "./autogen.sh" to create the actual configure file
115 and run configure as described above.
116
117 Kleopatra Locatization
118 ======================
119
120 The kde-l10n package is generated with the script src/kde-l10n.sh
121 execute it after a build to generate an updated l10n package which
122 you can then upload and add to packages.current.
123 The tarballs and the nsis scripts are located in the temp directory
124 kde-l10n prints as output.
125
126
127 Version numbers
128 ===============
129
130 We use a specific order of version numbers.  This is best shown by an
131 example:
132
133   1.0.0             - The final 1.0.0 release.
134   1.0.1-svn1234     - A snapshot based on SVN revision 1234
135   1.0.1-svn1235     - A newer snapshot
136   1.0.1rc1-svn1236  - A snapshot while preparing for a release candidate
137   1.0.1rc1          - The first release candidate for 1.0.1
138   1.0.1-svn1240     - yet another snapshot
139   1.0.1             - The final 1.0.1 release
140   2.1.1             - The final 2.1.1 release
141   2.1.1-beta88      - A snapshot before the 2.1.1 release.
142                       (The 88 in this example is the number of
143                        commits since the last release).
144
145 The important point is that we bump up the version number before we do
146 an release and append a suffix to mark it as a development version.
147 This allows other software to use a configure check for the next to be
148 released version of gpg4win.
149
150
151
152 Copyright
153 =========
154
155 The entire Gpg4win package is
156
157   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2012, 2013 g10 Code GmbH
158
159   GPG4Win is free software; you can redistribute it and/or modify it
160   under the terms of the GNU General Public License as published by
161   the Free Software Foundation; either version 2 of the License, or
162   (at your option) any later version.
163
164   GPG4Win is distributed in the hope that it will be useful, but
165   WITHOUT ANY WARRANTY; without even the implied warranty of
166   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
167   General Public License for more details.
168
169   You should have received a copy of the GNU General Public License
170   along with this program; if not, write to the Free Software
171   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
172   02110-1301, USA
173
174
175 This file
176 =========
177
178 Copyright 2005, 2006, 2008 g10 Code GmbH
179
180 This file is free software; as a special exception the author gives
181 unlimited permission to copy and/or distribute it, with or without
182 modifications, as long as this notice is preserved.
183
184 This file is distributed in the hope that it will be useful, but
185 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
186 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
187 PURPOSE.