summaryrefslogtreecommitdiff
path: root/doc/index.adoc
diff options
context:
space:
mode:
authorJohn Turner <jturner.usa@gmail.com>2025-09-14 00:16:10 -0400
committerJohn Turner <jturner.usa@gmail.com>2025-09-14 00:16:10 -0400
commitefcea3a80da7c4479d5fe168435ecc9fd06bdc72 (patch)
tree5cb0177e17b1b00a177f2e830e809f606334571b /doc/index.adoc
downloadsqlite-kv-bench-efcea3a80da7c4479d5fe168435ecc9fd06bdc72.tar.gz
Squashed 'subprojects/boost-sqlite/' content from commit 3378e35
git-subtree-dir: subprojects/boost-sqlite git-subtree-split: 3378e353705271e569cf4ba15c467b840a39798c
Diffstat (limited to 'doc/index.adoc')
-rw-r--r--doc/index.adoc28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/index.adoc b/doc/index.adoc
new file mode 100644
index 0000000..1ec5ec7
--- /dev/null
+++ b/doc/index.adoc
@@ -0,0 +1,28 @@
+= Documentation boost.sqlite
+Klemens Morgenstern <klemens.morgenstern@gmx.net>
+Version 1.0, 23.11.2024
+:source-highlighter: rouge
+:toc: left
+:toclevels: 4
+:icons: font
+:idprefix:
+:docinfo: private-footer
+:source-highlighter: rouge
+:source-language: c++
+:example-caption: Example
+:coderay-linenums-mode: inline
+
+:leveloffset: +1
+
+= Introduction
+
+This small C+\+-14 library, extending the excellent sqlite API for C++.
+It sticks as close as possible to the sqlite API, but adopts thing like errors or ranges.
+
+It is therefore highly recommended to study the https://www.sqlite.org/docs.html[sqlite documentation].
+
+include::tutorial.adoc[]
+include::functions.adoc[]
+include::extensions.adoc[]
+include::vtable.adoc[]
+include::reference.adoc[]