diff options
| author | Jack Lloyd <[email protected]> | 2019-05-31 23:08:48 -0400 |
|---|---|---|
| committer | Jack Lloyd <[email protected]> | 2019-05-31 23:34:34 -0400 |
| commit | 924bb1a52ec3dad476a5f8567a7411b18a3e7056 (patch) | |
| tree | be6ecc03c2cf7b6da23f51c85ab3d5170566d150 /doc/manual/index.rst | |
| parent | c610d318d37c899260a2d3f3e3692970c6f8d9ba (diff) | |
Reorg documentation layout. Rename manual to handbook.
Diffstat (limited to 'doc/manual/index.rst')
| -rw-r--r-- | doc/manual/index.rst | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/doc/manual/index.rst b/doc/manual/index.rst deleted file mode 100644 index d61d508e4..000000000 --- a/doc/manual/index.rst +++ /dev/null @@ -1,58 +0,0 @@ - -Getting Started -======================================== - -If you need to build the library first, start with :doc:`building`. -Some Linux distributions include packages for Botan, so building from -source may not be required on your system. - -.. only:: html - - The :ref:`genindex` and :ref:`search` may be useful to get started. - -.. only:: html and website - - You can also download this manual as a `PDF <https://botan.randombit.net/manual/botan.pdf>`_. - -Examples ----------- - -Some examples of usage are included in this documentation. However a better -source for example code is in the implementation of the -`command line interface <https://github.com/randombit/botan/tree/master/src/cli>`_, -which was intentionally written to act as practical examples of usage. - -Books and other references ----------------------------- - -You should have some knowledge of cryptography *before* trying to use -the library. This is an area where it is very easy to make mistakes, -and where things are often subtle and/or counterintuitive. Obviously -the library tries to provide things at a high level precisely to -minimize the number of ways things can go wrong, but naive use will -almost certainly not result in a secure system. - -Especially recommended are: - -- *Cryptography Engineering* - by Niels Ferguson, Bruce Schneier, and Tadayoshi Kohno - -- `Security Engineering -- A Guide to Building Dependable Distributed Systems - <https://www.cl.cam.ac.uk/~rja14/book.html>`_ by Ross Anderson - -- `Handbook of Applied Cryptography <http://www.cacr.math.uwaterloo.ca/hac/>`_ - by Alfred J. Menezes, Paul C. Van Oorschot, and Scott A. Vanstone - -If you're doing something non-trivial or unique, you might want to at -the very least ask for review/input at a place such as the -`metzdowd <http://www.metzdowd.com/mailman/listinfo/cryptography>`_ or -`randombit <https://lists.randombit.net/mailman/listinfo/cryptography>`_ -mailing lists or the -`cryptography stack exchange <https://crypto.stackexchange.com/>`_. -And (if possible) pay a professional cryptographer or security company -to review your design and code. - - -.. toctree:: - :maxdepth: 1 - :numbered: |