diff --git a/README.md b/README.md index 8973214ca16d..51eb3a52489d 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,29 @@ -AvocadoDB -========= +# AvocadoDB My colleagues and I started developing a document-store, which focuses on durability of the data taking advantage of new technologies like SSD, support for graph and geo algorithms needed in social networks, ease of use for the developer and minimal effort to operate for the administrator. -Compilation -=========== +## Compilation -(1) Install V8 +1. Install Dependencies: V8, boost, libev +2. autoconf +3. ./configure --with-boost=PATH_TO_BOOST --with-libev=PATH_TO_LIBEV --with-v8=PATH_TO_V8 +4. make +5. create a directory `/var/lib/avocado` where you are allowed to read and write +6. "./avocdb" to start a REST server or "./avocdb --shell" for debugging -(2) ./configure --with-v8=/home/huerth/fceller/IPP/3rdParty/v8 +### Mac OS X Hints -(3) "./avocado" to start a REST server or "./avocado --shell" for debugging +If you install AvocadoDB on Mac OS X we collected some hints for you: -First Steps -=========== +* The version of bison delivered with OS X is out of date. Update it before installing. +* Due to the oddities of the boost library, at least the homebrew version requires some modification: In `/usr/local/Cellar/boost/1.48.0/lib` sym-link the regex, system and programm-option libraries to a name without `-mt` - ./avocado --shell +## First Steps + + ./avocdb --shell avocado> db.examples.count(); avocado> db.examples.save({ Hallo: "World" }); avocado> db.examples.select();