Add build instructions and update README
[gpgol.git] / README
1                          GpgOL Version 0.10.x
2                        =======================
3           Copyright (C) 2004, 2005, 2007, 2008, 2009, 2010,
4                         2011 g10 Code GmbH
5
6
7 GpgOL is a GnuPG plugin for MS Outlook.
8
9 WARNING:  This version requires the decent version of Kleopatra or GPA.
10
11
12 .          Top directory with build scripts and information files.
13
14 src/       Code to build the actual core of the plugin.  The resulting
15            DLL will be named "gpgol.dll".  It is to be build using
16            the Mingw toolchain.
17
18 To install this plugin, copy "gpgol.dll" to some directory (e.g. where
19 gpg lives), make sure that the libgpg-error.dll and gpgme.dll are
20 available in a directory where Windows searches for DLLs
21 (e.g. c:\winnt\system32), stop Outlook, run the command "regsvr32
22 gpgol.dll" and start Outlook. You should then find a new tab named
23 "GnuPG" in Outlook's option menu.
24
25 You will need an UiServer (either GPA or Kleopatra) in a location
26 pointed to by the standard gpg4win registry keys. It is suggested
27 you install gpg4win and then replace the gpgol.dll with your
28 compiled binary.
29
30 If you are missing icons in the toolbar, checkout the toolbar's
31 customize button - you will find the new icons there.
32
33 Bug reporting: First click on the logo on the GnuPG options tab to
34 check whether a newer version has been released - try this first.  If
35 this does not help, check out the mailing lists and also the bug
36 archive at http://bugs.gnupg.org (use username and password "guest",
37 select "query" and there category "gpgol") if you did not found any
38 information there please send a report, including all relevant version
39 numbers to the address given at the top of this AUTHORS file.