aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2017-01-02 16:08:20 -0500
committerJack Lloyd <[email protected]>2017-01-02 16:08:20 -0500
commitfc914bd13659da7ee6590fa535ae6074a2db85f9 (patch)
treea00622e854c2728175d74fd1298cb8fa7f87506f /doc
parent51d2e35883fe040005d664390bbf2b84406c2a5b (diff)
Remove unhelpful firststep.rst
A general intro/outline doc would be useful, but this isn't it. [ci skip]
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/contents.rst1
-rw-r--r--doc/manual/firststep.rst38
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.