diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/contents.rst | 1 | ||||
| -rw-r--r-- | doc/manual/firststep.rst | 38 |
2 files changed, 0 insertions, 39 deletions
diff --git a/doc/manual/contents.rst b/doc/manual/contents.rst index 67665667b..48ae83334 100644 --- a/doc/manual/contents.rst +++ b/doc/manual/contents.rst @@ -8,7 +8,6 @@ Contents goals building platforms - firststep versions secmem rng diff --git a/doc/manual/firststep.rst b/doc/manual/firststep.rst deleted file mode 100644 index 2f998687d..000000000 --- a/doc/manual/firststep.rst +++ /dev/null @@ -1,38 +0,0 @@ - -Getting Started -======================================== - -All declarations in the library are contained within the namespace -``Botan``, so you need to either prefix types with ``Botan::`` or add -a ``using`` declaration in your code. All examples will assume a -``using`` declaration. - -All library headers are included like so:: - - #include <botan/auto_rng.h> - -Pitfalls ----------------------------------------- - -Use a ``try``/``catch`` block inside your ``main`` function, and catch -any ``std::exception`` throws (remember to catch by reference, as -``std::exception::what`` is polymorphic):: - - int main() - { - try - { - LibraryInitializer init; - - // ... - } - catch(std::exception& e) - { - std::cerr << e.what() << "\n"; - } - } - -This is not strictly required, but if you don't, and Botan throws an -exception, the runtime will call ``std::terminate``, which usually -calls ``abort`` or something like it, leaving you (or worse, a user of -your application) wondering what went wrong. |