aboutsummaryrefslogtreecommitdiffstats
path: root/readme.txt
diff options
context:
space:
mode:
authorlloyd <[email protected]>2008-11-30 19:14:16 +0000
committerlloyd <[email protected]>2008-11-30 19:14:16 +0000
commit2c06f994fc04d68d73d494c087e2f815382f2752 (patch)
treeb2cbe03f524af9105327ab967c25ab8e4c1812b8 /readme.txt
parent3728eeca206f8ceeee32f9be507f4b7a9d2e4ee0 (diff)
Consolidate the useful stuff from doc/info.txt into readme.txt
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt41
1 files changed, 33 insertions, 8 deletions
diff --git a/readme.txt b/readme.txt
index a8b06f389..d3cd3ff33 100644
--- a/readme.txt
+++ b/readme.txt
@@ -1,16 +1,41 @@
-Botan 1.7.24-pre ????-??-??
+Botan 1.7.24 2008-12-01
http://botan.randombit.net/
-This is the third release candidate of Botan 1.8.0. We consider it the
+Botan is a C++ class library for performing a wide variety of
+cryptographic operations.
+
+This is the third release candidate for Botan 1.8.0. I consider it the
best version of Botan available, and recommend all users upgrade from
1.6 or earlier versions as soon as possible. Some APIs have changed
incompatibly since the 1.6 release series, but most applications
should work as-is or with only simple modifications.
-You can file bugs in Bugzilla (http://www.randombit.net/bugzilla) or
-by sending a report to the botan-devel mailing list
-(http://lists.randombit.net/mailman/listinfo/botan-devel)
+Botan is licensed under a BSD-like license, the terms of which are
+specified in 'doc/license.txt'. More information about the authors and
+contributors can be found in 'doc/credits.txt' and 'doc/thanks.txt'
+
+You can file bugs in Bugzilla, which can be accessed at
+ http://www.randombit.net/bugzilla/
+or by sending a report to the botan-devel mailing list
+ http://lists.randombit.net/mailman/listinfo/botan-devel/
+
+In the doc directory, there should be a set of PDFs, including
+
+building.pdf - Build instructions
+api.pdf - API reference manual
+tutorial.pdf - A set of simple examples and tutorials
+
+Other examples can be found in the doc/examples directory.
+
+Some higher level protocols are implemented on top of Botan by:
+
+NetSieben SSH Library (SSHv2): http://www.netsieben.com/products/ssh/
+Ajisai (SSLv3/TLSv1): http://www.randombit.net/code/ajisai/
+
+Check http://botan.randombit.net/ for announcements and new
+releases. If you'll be developing code using Botan, consider joining
+the mailing lists. And feel free to contact me with any questions or
+comments.
-For more information, see info.txt, the build instructions, the API
-reference manual, and the tutorial, all of which can be found in the
-doc/ directory.
+Regards,
+ Jack Lloyd ([email protected])