From ba48775cac97e7f478a6852b2c45f332535a8d7d Mon Sep 17 00:00:00 2001 From: Anurag Khandelwal Date: Sat, 21 May 2016 18:09:56 -0700 Subject: [PATCH] Added instructions for examples --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0ca8813..0358b38 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,11 @@ To clean-up build files, run: ./cleanup.sh ``` -# Constructing datasets +# Examples -TODO: Add description of how `construct` tool can be used. +To see how Succinct's core data structures can be used, find examples in [examples/src](examples/src). + +The example in [compress.cc](examples/src/compress.cc) shows how Succinct can be used to compress input files (for both flat-file and key-value interfaces), while example programs in [query_file.cc](examples/src/query_file.cc) and [query_kv.cc](examples/src/query_kv.cc) show how the compressed files can be queried. # Starting Succinct as a Service