aboutsummaryrefslogtreecommitdiffstats
path: root/readme.rst
diff options
context:
space:
mode:
authorlloyd <[email protected]>2015-03-08 21:23:28 +0000
committerlloyd <[email protected]>2015-03-08 21:23:28 +0000
commit9d151adc7cb19831ea844d98fc13af27b790e369 (patch)
tree956ccd68efeecc2e6aff5e8e480339c170780e21 /readme.rst
parentc84b150c50093c680f18f0792bf7d52f157b01fe (diff)
Cleanups
Diffstat (limited to 'readme.rst')
-rw-r--r--readme.rst18
1 files changed, 15 insertions, 3 deletions
diff --git a/readme.rst b/readme.rst
index 6034ae45c..4ec23e91d 100644
--- a/readme.rst
+++ b/readme.rst
@@ -2,12 +2,24 @@ Botan Crypto Library
========================================
Botan is a C++11 library for crypto and TLS released under the permissive
-2-clause BSD license (see ``doc/license.rst`` for the specifics).
+2-clause BSD license (see ``doc/license.txt`` for the specifics).
+
+For full instructions on building the library, read
+``doc/manual/building.rst``, but basically::
+
+ $ configure.py --help
+ $ configure.py [probably some options]
+ $ make
+ $ ./botan-test
+ # test output
+ $ ./botan
+ # shows available commands
+ $ make install
You can file bugs in `GitHub Issues
<https://github.com/randombit/botan/issues/>`_ or by sending a
report to the `botan-devel mailing list
<http://lists.randombit.net/mailman/listinfo/botan-devel/>`_
-For instructions on building the library, read ``doc/manual/building.rst``.
-
+The `github wiki <https://github.com/randombit/botan/wiki>`_
+is also available as a resource.