Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pwaller committed Oct 15, 2013
1 parent 26e3c5d commit 412d00c
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
@@ -1,7 +1,38 @@
Drillbit
--------

Poster
------

<http://www.ebke.org/drillbit_poster_chep2013.pdf>

Abstract
--------

Drillbit is an experimental new data storage format, which already shows great promise.
Feel free to play around, however keep in mind that drillbit is currently in the prototyping stage.

Drillbit is licensed under the AGPL v3 as specified in the LICENSE file. This means that you can use drillbit only in open source code. Please contact us if you wish to discuss alternative licensing.

Getting started
---------------

You will need to install libprotobuf-dev libraries through your favourite package manager.

Then (as a normal user) at the console run:

```bash
./waf configure --prefix=install
./waf install
```

This will install the binaries to `${PWD}/install/bin`.

Commands
--------

* `speedtests <mode> <dit files>...`: Speed test reading dit files
* `root2stripes [-h|--help] [-t treename] [-m pattern] [file]...`: Explode a root file
* `stripes2root [dit files]...`: inverse of root2stripes
* `make_test_dit`: Requires `${PWD}/dit_test` directory to exist, builds some test columns

0 comments on commit 412d00c

Please sign in to comment.