Also switch to attic for KMime
[gpg4win.git] / README
diff --git a/README b/README
index ba09403..e5a67da 100644 (file)
--- a/README
+++ b/README
@@ -2,6 +2,8 @@ This is gpg4win - the GUI Installer Builder for W32.
 
 See also the file doc/README.en.txt.
 
+For MSI Package instructions see src/README-msi.txt.
+
 Instructions:
 =============
 
@@ -13,6 +15,10 @@ Instructions:
    [...]
    $ cd ..
 
+1.5 (Only necessary when building from Git)
+
+   $ ./autogen.sh
+
 2. Configure the source tree for cross compilation:
 
    $ ./autogen.sh --build-w32
@@ -21,10 +27,9 @@ Instructions:
 
    $ make
 
-The installer will be made available in three files:
+The installer will be made available in two files:
 
 src/gpg4win-X.Y.Z.exe
-src/gpg4win-light-X.Y.Z.exe
 src/gpg4win-src-X.Y.Z.exe
 
 
@@ -32,44 +37,29 @@ Basic requirements
 ==================
 
 A decent POSIX system is required for building this software as well
-as GNU make.  We are using Debian GNU/Linux (Lenny); due to a little
-bug in the mingw32 compiler it is highly suggested to put a line
-  deb http://apt.intevation.org lenny/mingw .
-into /etc/apt/sources and update the mingw packages.  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)
- mingw32
- nsis
- stow
- unzip
- texinfo
- imagemagick
- tetex-bin
- tetex-extra
- latex-xcolor (for the compendium)
- tr
- gs-common (gs)
- docbook-utils
- hyperlatex
- sharutils (uudecode for claws icon patch)
- gettext (msgfmt, dcgettext, gmsgfmt, xgettext for glib)
- libglib2.0-dev (glib-genmarshal, glib-compile-{resources,schemas})
- libgdk-pixbuf2.0-dev (gdk-pixbuf-csource)
- docbook-utils, ghostscript (claws-mail manual)
+as GNU make.  We are using Debian GNU/Linux 9 (stretch), any other
+POSIX system should work as well but you may run into problems due to
+different toolchain versions. For MSI Packages you will additionally
+need the dependencies mentioned in src/README-msi.txt
 
+To satisfy all needs of configure at least the following packages need
+to be installed:
+
+    build-essential autoconf automake mingw-w64 mingw-w64-i686-dev \
+    mingw-w64-x86-64-dev nsis stow unzip imagemagick texlive \
+    latex-xcolor libglib2.0-dev gettext docbook-utils ghostscript \
+    texinfo libgdk-pixbuf2.0-dev texlive-latex-extra libqt4-dev-bin \
+    wget mingw-w64 texlive-lang-german cmake libgtk2.0-bin libxml2-utils \
+    gperf 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
 ====================
@@ -87,7 +77,7 @@ Adding new packages to the installer:
 This requires editing a couple of files; we might eventually automate
 some of these tasks.  Here is a short run up:
 
-1. Add constants for the package FOO into include/config.nsi.in .
+1. Add constants for the package FOO into src/config.nsi.in .
 
 2. Create 2 new installer scripts, named src/inst-foo.nsi and
    uninst-foo.nsi and add them to EXTRA_DIST in src/Makefile.am.
@@ -97,7 +87,7 @@ some of these tasks.  Here is a short run up:
    gpg4win) in src/Makefile.am .  Also add any required configure
    flags etc.
 
-4. Add FOO to inst-sections.nsi.
+4. Add FOO to src/inst-sections.nsi.
 
 5. Add detection of packages to configure.ac.  Check out the available
    macros in m4/gpg4win.m4.  Depending on the way an upstream package
@@ -111,9 +101,29 @@ some of these tasks.  Here is a short run up:
    within gpg4win (or peculiarly shipped), or in the development
    package ${pkgidir_dev}.
 
+8. Add the installed files to the mkportable headers.
+
 Then run the usual "./autogen.sh" to create the actual configure file
 and run configure as described above.
 
+Kleopatra Locatization
+======================
+
+The kde-l10n package is generated with the script src/kde-l10n.sh
+execute it after a build to generate an updated l10n package which
+you can then upload and add to packages.current.
+The tarballs and the nsis scripts are located in the temp directory
+kde-l10n prints as output.
+
+
+Installer Slideshow
+===================
+
+During installation we are showing a slide show. If you want to
+change the contents shown add / modify files in the src/slideshow
+subfolder. Install them in inst-gpg4win.nsi (Add them to the list
+of files before g4wihelp::slide_show) and modify
+src/slideshow/slides.dat accordingly.
 
 Version numbers
 ===============
@@ -121,13 +131,10 @@ 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.
@@ -141,7 +148,7 @@ Copyright
 
 The entire Gpg4win package is
 
-  Copyright (C) 2005, 2006, 2007, 2008, 2009 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