featurebase/README.md
Ben Johnson 34fa1afad0 refactor
This commit refactors the pilosa codebase. It makes several major
changes:

* Removes bitmap handles
* Removes dispatch/hold/transport
* Removes etcd dependency
* Adds consistent hash ring for slice placement
* Refactors parser/lexer
* Adds strong typing to PQL AST
* Flattens package hierarchy
2015-12-02 15:34:49 -07:00

54 lines
842 B
Markdown

# pilosa
Pilosa is a bitmap index database.
## Getting Started
Pilosa uses the new Go 1.5 vendoring experiment. To enable this, you'll need
to export an environment variable in your `.profile`:
```sh
export GO15VENDOREXPERIMENT=1
```
Then you can download the source by running `go get`:
```sh
$ go get github.com/umbel/pilosa
```
Now you can install the `pilosa` binary:
```sh
$ go install github.com/umbel/pilosa/...
```
Now run `pilosa` with the default configuration:
```sh
pilosa
```
## Development
### Updating dependencies
To update dependencies, you'll need to install [godep][]:
```sh
$ go get -u github.com/tools/godep
```
Then save the dependencies in your project:
```sh
$ godep save ./...
```
*Make sure you have set the `GO15VENDOREXPERIMENT` environment variable!*
[godep]: https://github.com/tools/godep