Add first KDE Framework and infrastructure for it
[gpg4win.git] / README
diff --git a/README b/README
index 46dbf41..0ad59f2 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,6 @@
 This is gpg4win - the GUI Installer Builder for W32.
 
+See also the file doc/README.en.txt.
 
 Instructions:
 =============
@@ -12,22 +13,18 @@ Instructions:
    [...]
    $ cd ..
 
-   If you have downloaded gnupg-2.x, you need to rename that tarball.
-   e.g.:
-   
-     mv gnupg-2.0.5.tar.bz2 gnupg2-2.0.5.tar.bz2
-
 2. Configure the source tree for cross compilation:
 
-   $ configure --host=i586-mingw32msvc
+   $ ./autogen.sh --build-w32
 
 3. Build the installer:
 
    $ make
 
-The installer will be made available in two files:
+The installer will be made available in three files:
 
 src/gpg4win-X.Y.Z.exe
+src/gpg4win-light-X.Y.Z.exe
 src/gpg4win-src-X.Y.Z.exe
 
 
@@ -35,46 +32,53 @@ Basic requirements
 ==================
 
 A decent POSIX system is required for building this software as well
-as GNU make.  We are using Debian GNU/Linux (Sid), however it should
-work with current Testing (as of Februar 2006) too.  It might work with
-Sarge - this has not been tested.  To satisfy all needs of configure
-at least the following packages need to be installed:
+as GNU make.  We are using Debian GNU/Linux 8 (Jessie), any other
+POSIX system should work as well but you may run into problems due to
+different toolchain versions.
+
+To satisfy all needs of configure at least the following packages need
+to be installed:
 
  build-essential (libc6-dev, gcc, g++, make)
- automake, autoconf (if building from SVN)
+ automake, autoconf (if building from GIT)
  mingw32
+ mingw-w64
+ mingw-w64-i686-dev
+ mingw-w64-x86-64-dev
  nsis
  stow
  unzip
  texinfo
  imagemagick
- tetex-bin
- tetex-extra
- tr
- gs-common
- hyperlatex
- sharutils (uudecode for claws icon patch)
+ gs-common | ghostscript (gs)
+ docbook-utils
  gettext (msgfmt, dcgettext, gmsgfmt, xgettext for glib)
- libglib2.0-dev (glib-genmarshal for glib)
+ libglib2.0-dev (glib-genmarshal, glib-compile-{resources,schemas})
+ libgdk-pixbuf2.0-dev (gdk-pixbuf-csource)
+ texlive (you need most modules)
+ texlive-latex-extra
+ texlive-lang-german
+ latex-xcolor (for the compendium)
+ libqt4-dev-bin (in case pinentry-qt needs moc)
+ libgettextpo-dev
 
 
 Building the Webpages
 =====================
 
-This has not been automated.  See the README file in the doc/website
-directory.  To build the HTML version of the manuals you need to go to
-doc/manual-de, run the command "make webversion" and copy the require
-files to the desired location.  If you are a developer with write
-access to the Sibversion, you may use the "online" target to actually
-update the website.
+The website is in the dedicated branch "website" in the git reposity.
+Checkout that branch and read the instructions:
+
+  git checkout website
+
 
 Development Branches
 ====================
 
 The old version of gpg4win (version < 1.2) is since 1.1.3 tracked by
-the SVN branch: branches/gpg4win-1-branch.  Only important fixes will
-go into this version.  The current version is in the SVN trunk starts
-as version 1.9 and will soon lead to version 2.0.
+the GIT branch: gpg4win-1-branch.  Only important fixes will go into
+this version.  The current version in the GIT master starts as version
+1.9.
 
 
 
@@ -112,23 +116,48 @@ Then run the usual "./autogen.sh" to create the actual configure file
 and run configure as described above.
 
 
+Version numbers
+===============
+
+We use a specific order of version numbers.  This is best shown by an
+example:
+
+  1.0.0             - The final 1.0.0 release.
+  1.0.1-svn1234     - A snapshot based on SVN revision 1234
+  1.0.1-svn1235     - A newer snapshot
+  1.0.1rc1-svn1236  - A snapshot while preparing for a release candidate
+  1.0.1rc1          - The first release candidate for 1.0.1
+  1.0.1-svn1240     - yet another snapshot
+  1.0.1             - The final 1.0.1 release
+  2.1.1             - The final 2.1.1 release
+  2.1.1-beta88      - A snapshot before the 2.1.1 release.
+                      (The 88 in this example is the number of
+                       commits since the last release).
+
+The important point is that we bump up the version number before we do
+an release and append a suffix to mark it as a development version.
+This allows other software to use a configure check for the next to be
+released version of gpg4win.
+
+
+
 Copyright
 =========
 
 The entire Gpg4win package is
 
-  Copyright (C) 2005, 2006, 2007, 2008 g10 Code GmbH
-  
+  Copyright (C) 2005, 2006, 2007, 2008, 2009, 2012, 2013 g10 Code GmbH
+
   GPG4Win is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
-  
+
   GPG4Win is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.
-  
+
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA