summaryrefslogtreecommitdiffstats
path: root/guide/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'guide/src/lib.rs')
-rw-r--r--guide/src/lib.rs22
1 files changed, 22 insertions, 0 deletions
diff --git a/guide/src/lib.rs b/guide/src/lib.rs
new file mode 100644
index 00000000..e1e33403
--- /dev/null
+++ b/guide/src/lib.rs
@@ -0,0 +1,22 @@
+#![doc="
+Climbing Sequoias.
+
+This is our guided tour through the Sequoia OpenPGP library.
+
+Please note that this guide as well as Sequoia is work in progress.
+But, fear not! This guide is part of the API documentation, and the
+code fragments are tested as part of Sequoias test suite. This makes
+sure that this guide is always up-to-date.
+
+For more inspiration, see our various [examples] and our
+command-line frontends [sq] and [sqv].
+
+[examples]: https://gitlab.com/sequoia-pgp/sequoia/tree/master/openpgp/examples
+[sq]: https://gitlab.com/sequoia-pgp/sequoia/tree/master/tool
+[sqv]: https://gitlab.com/sequoia-pgp/sequoia/tree/master/sqv
+
+Happy climbing!
+
+"]
+
+include!(concat!(env!("OUT_DIR"), "/src/lib.rs"));