changed manualinprogress, fix deleted screenshot
[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    $ ./autogen.sh --build-w32
18
19 3. Build the installer:
20
21    $ make
22
23 The installer will be made available in three files:
24
25 src/gpg4win-X.Y.Z.exe
26 src/gpg4win-light-X.Y.Z.exe
27 src/gpg4win-src-X.Y.Z.exe
28
29
30 Basic requirements
31 ==================
32
33 A decent POSIX system is required for building this software as well
34 as GNU make.  We are using Debian GNU/Linux (Sid), however it should
35 work with current Testing (as of Februar 2006) too.  It might work with
36 Sarge - this has not been tested.  To satisfy all needs of configure
37 at least the following packages need to be installed:
38
39  build-essential (libc6-dev, gcc, g++, make)
40  automake, autoconf (if building from SVN)
41  mingw32
42  nsis
43  stow
44  unzip
45  texinfo
46  imagemagick
47  tetex-bin
48  tetex-extra
49  latex-xcolor (for the compendium)
50  tr
51  gs-common
52  hyperlatex
53  sharutils (uudecode for claws icon patch)
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 7. If the package ships pkg-config (*.pc) support files, you need add
103    post install instructions to Makefile.am.  Note that *.pc files may
104    be in the "runtime" directory ${pkgidir} if the package is built
105    within gpg4win (or peculiarly shipped), or in the development
106    package ${pkgidir_dev}.
107
108 Then run the usual "./autogen.sh" to create the actual configure file
109 and run configure as described above.
110
111
112 Copyright
113 =========
114
115 The entire Gpg4win package is
116
117   Copyright (C) 2005, 2006, 2007, 2008 g10 Code GmbH
118   
119   GPG4Win is free software; you can redistribute it and/or modify it
120   under the terms of the GNU General Public License as published by
121   the Free Software Foundation; either version 2 of the License, or
122   (at your option) any later version.
123   
124   GPG4Win is distributed in the hope that it will be useful, but
125   WITHOUT ANY WARRANTY; without even the implied warranty of
126   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
127   General Public License for more details.
128   
129   You should have received a copy of the GNU General Public License
130   along with this program; if not, write to the Free Software
131   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
132   02110-1301, USA
133
134
135 This file
136 =========
137
138 Copyright 2005, 2006, 2008 g10 Code GmbH
139
140 This file is free software; as a special exception the author gives
141 unlimited permission to copy and/or distribute it, with or without
142 modifications, as long as this notice is preserved.
143
144 This file is distributed in the hope that it will be useful, but
145 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
146 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
147 PURPOSE.