Skip to content

Commit

Permalink
Added instructions for examples
Browse files Browse the repository at this point in the history
  • Loading branch information
anuragkh committed May 22, 2016
1 parent 1e4ecba commit ba48775
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit ba48775

Please sign in to comment.