core: Minor cleanup of commit 195c735
[gpgme.git] / README
diff --git a/README b/README
index 01d7d3a..b7483b2 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
-                  GPGME - GnuPG Made Easy
-                ---------------------------
+                       GPGME - GnuPG Made Easy
+                     ---------------------------
 
 
-               Copyright 2004, 2006, 2010 g10 Code GmbH
+                  Copyright 2001-2016 g10 Code GmbH
 
 This file is free software; as a special exception the author gives
 unlimited permission to copy and/or distribute it, with or without
 
 This file is free software; as a special exception the author gives
 unlimited permission to copy and/or distribute it, with or without
@@ -22,14 +22,15 @@ to public key crypto engines like GnuPG or GpgSM easier for
 applications.  GPGME provides a high-level crypto API for encryption,
 decryption, signing, signature verification and key management.
 
 applications.  GPGME provides a high-level crypto API for encryption,
 decryption, signing, signature verification and key management.
 
+GPGME comes with language bindings for Common Lisp, C++, QT, Python2
+and Python 3.
+
 GPGME uses GnuPG and GpgSM as its backends to support OpenPGP and the
 Cryptographic Message Syntax (CMS).
 
 GPGME uses GnuPG and GpgSM as its backends to support OpenPGP and the
 Cryptographic Message Syntax (CMS).
 
-GPGME runs best on GNU/Linux or *BSD systems.  Other Unices may
-require small portability fixes, send us your patches.
-
-See the file COPYING.LESSER and each file for copyright and warranty
-information.
+See the files COPYING, COPYING.LESSER, and each file for copyright and
+warranty information.  The file AUTHORS has a list of authors and
+useful web and mail addresses.
 
 
 Installation
 
 
 Installation
@@ -40,32 +41,16 @@ See the file INSTALL for generic installation instructions.
 Check that you have unmodified sources.  See below on how to do this.
 Don't skip it - this is an important step!
 
 Check that you have unmodified sources.  See below on how to do this.
 Don't skip it - this is an important step!
 
-To build GPGME, you need to install libgpg-error.  You need at least
-libgpg-error 0.5.
+To build GPGME, you need to install libgpg-error (>= 1.11) and
+Libassuan (>= 2.0.2).
 
 For support of the OpenPGP protocol (default), you should use the
 
 For support of the OpenPGP protocol (default), you should use the
-latest version of GnuPG 1.2 or 1.4, available at:
-ftp://ftp.gnupg.org/gcrypt/gnupg/
-
-You need at least GnuPG 1.2.2.
-
-If configure can't find the `gpg' binary in your path, you can specify
-the location with the --with-gpg=/path/to/gpg argument to configure.
-
-For support of the CMS (Cryptographic Message Syntax) protocol, you
-need the latest CVS version of GnuPG 1.9, which is available in the
-GnuPG repository:
-http://www.gnupg.org/download/cvs_access.html
-Use the tag `GNUPG-1-9-BRANCH'.  There are also snapshots available at:
-ftp://ftp.gnupg.org/gcrypt/alpha/gnupg/
+latest version of GnuPG (>= 1.4) , available at:
+ftp://ftp.gnupg.org/gcrypt/gnupg/.  For support of the CMS
+(Cryptographic Message Syntax) protocol and lot of other features, you
+need a GnuPG version >= 2.0.
 
 
-You need at least GpgSM 1.9.6.
-
-If configure can't find the `gpgsm' binary in your path, you can
-specify the location with the --with-gpgsm=/path/to/gpgsm argument to
-configure.
-
-For building the CVS version of GPGME please see the file README.CVS
+For building the GIT version of GPGME please see the file README.GIT
 for more information.
 
 
 for more information.
 
 
@@ -79,24 +64,38 @@ following ways:
 a) If you have a trusted Version of GnuPG installed, you can simply check
    the supplied signature:
 
 a) If you have a trusted Version of GnuPG installed, you can simply check
    the supplied signature:
 
-       $ gpg --verify gpgme-x.y.z.tar.gz.sig
+       $ gpg --verify gpgme-x.y.z.tar.gz.sig gpgme-x.y.z.tar.gz
 
    This checks that the detached signature gpgme-x.y.z.tar.gz.sig is
    indeed a a signature of gpgme-x.y.z.tar.gz.  The key used to create
    this signature is either of:
 
 
    This checks that the detached signature gpgme-x.y.z.tar.gz.sig is
    indeed a a signature of gpgme-x.y.z.tar.gz.  The key used to create
    this signature is either of:
 
-   "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
-   "pub  1024D/87978569 1999-05-13
-                        Marcus Brinkmann <Marcus.Brinkmann@ruhr-uni-bochum.de>
-                        Marcus Brinkmann <mb@g10code.com>"
+     2048R/4F25E3B6 2011-01-12 [expires: 2019-12-31]
+     Key fingerprint = D869 2123 C406 5DEA 5E0F  3AB5 249B 39D2 4F25 E3B6
+     Werner Koch (dist sig)
+
+     rsa2048/E0856959 2014-10-29 [expires: 2019-12-31]
+     Key fingerprint = 46CC 7308 65BB 5C78 EBAB  ADCF 0437 6F3E E085 6959
+     David Shaw (GnuPG Release Signing Key) <dshaw 'at' jabberwocky.com>
+
+     rsa2048/33BD3F06 2014-10-29 [expires: 2016-10-28]
+     Key fingerprint = 031E C253 6E58 0D8E A286  A9F2 2071 B08A 33BD 3F06
+     NIIBE Yutaka (GnuPG Release Key) <gniibe 'at' fsij.org>
+
+     rsa2048/7EFD60D9 2014-10-19 [expires: 2020-12-31]
+     Key fingerprint = D238 EA65 D64C 67ED 4C30  73F2 8A86 1B1C 7EFD 60D9
+     Werner Koch (Release Signing Key)
 
 
-   If you do not have this key, you can get it from any keyserver.  You
-   have to make sure that this is really the key and not a faked one.
-   You can do this by comparing the output of:
+   You may retrieve these files from the keyservers using this command
 
 
-       $ gpg --fingerprint 0x57548DCD
+     gpg --recv-keys 249B39D24F25E3B6 04376F3EE0856959 \
+                     2071B08A33BD3F06 8A861B1C7EFD60D9
 
 
-   with the fingerprint published elsewhere.
+   The keys are also available at https://gnupg.org/signature_key.html
+   and in released GnuPG tarballs in the file g10/distsigkey.gpg .
+   You have to make sure that these are really the desired keys and
+   not faked one.  You should do this by comparing the fingerprints
+   with the fingerprints published elsewhere.
 
 b) If you don't have any of the above programs, you have to verify
    the SHA1 checksum:
 
 b) If you don't have any of the above programs, you have to verify
    the SHA1 checksum:
@@ -116,8 +115,9 @@ Documentation
 
 For information how to use the library you can read the info manual,
 which is also a reference book, in the doc/ directory.  The programs
 
 For information how to use the library you can read the info manual,
 which is also a reference book, in the doc/ directory.  The programs
-in the tests/gpg/ directory may also prove useful.
+in the tests/ directory may also prove useful.
 
 Please subscribe to the gnupg-devel@gnupg.org mailing list if you want
 to do serious work.
 
 
 Please subscribe to the gnupg-devel@gnupg.org mailing list if you want
 to do serious work.
 
+For hacking on GPGME, please have a look at doc/HACKING.