From 13f16b04843745ab1cc55438457fe0a3f07f1200 Mon Sep 17 00:00:00 2001 From: John Shahid Date: Wed, 6 Nov 2013 11:01:31 -0500 Subject: [PATCH] fix #13. update the docs with build instructions on Mac OS and Linux. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index ceecd28f79..48bbef74e0 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,24 @@ Read an [overview of the design goals and reasons for the project](http://influx Check out the [getting started guide](http://influxdb.org/docs/) to read about how to install InfluxDB, start writing data, and issue queries in just a few minutes. See the [list of libraries for different langauges](http://influxdb.org/docs/libraries/javascript.html). Or see the [HTTP API documentation to start writing a library for your favorite language](http://influxdb.org/docs/api/http.html). + +## Building + +### Mac OS + +- install the build dependencies of the project `brew install protobuf bison flex leveldb go hg bzr` +- Run `./test.sh` + +The second step should build the server and run the tests. + +Note: if you're on Mac OS Maverick, you might want to try to install go using `brew install go --devel` + +### Linux + +- You need to get go from [here](http://code.google.com/p/go/downloads/list) +- Make sure go is on your PATH +- If you're on a redhat based distro `sudo yum install hg bzr protobuf-compiler flex bison` +- If you're on a debian based distro `sudo apt-get install hg bzr protobuf-compiler flex bison` +- Run `./test.sh` + +The last step should build the server and run the tests.