summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..0a4609e
--- /dev/null
+++ b/README.org
@@ -0,0 +1,12 @@
+* how to use
+First create the test database with ~scripts/mkdb.py~.
+
+The benchmark executable reads keys from stdin.
+
+An example run of the benchmark:
+
+#+BEGIN_SRC_BASH
+sqlite3 "${database}" "select kv.key from kv" | shuf | bench ${database}
+#+END_SRC
+
+