diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..fcd3260 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,20 @@ +language: go + +install: + - go get github.com/jacobsa/ogletest + - go get github.com/jacobsa/oglematchers + - go get github.com/smartystreets/goconvey + - go get github.com/badgerodon/peg + - go get github.com/barakmich/glog + - go get github.com/julienschmidt/httprouter + - go get github.com/petar/GoLLRB/llrb + - go get github.com/robertkrimen/otto + - go get github.com/russross/blackfriday + - go get github.com/stretchrcom/testify/mock + - go get github.com/syndtr/goleveldb/leveldb + - go get github.com/syndtr/goleveldb/leveldb/cache + - go get github.com/syndtr/goleveldb/leveldb/iterator + - go get github.com/syndtr/goleveldb/leveldb/opt + - go get github.com/syndtr/goleveldb/leveldb/util + - go get labix.org/v2/mgo + - go get labix.org/v2/mgo/bson diff --git a/README.md b/README.md index 417206b..43b1ad9 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Its goal is to be a part of the developer's toolbox where [Linked Data](http://l * or a REPL if you prefer * Built-in query editor and visualizer * Multiple query languages: - * Javascript, with a [Gremlin](http://gremlindocs.com/)-inspired\* graph object. + * JavaScript, with a [Gremlin](http://gremlindocs.com/)-inspired\* graph object. * (simplified) [MQL](https://developers.google.com/freebase/v1/mql-overview), for Freebase fans * Plays well with multiple backend stores: * [LevelDB](http://code.google.com/p/leveldb/) for single-machine storage @@ -45,7 +45,7 @@ You should see a `cayley>` REPL prompt. Go ahead and give it a try: // Simple math cayley> 2 + 2 -// Javascript syntax +// JavaScript syntax cayley> x = 2 * 8 cayley> x @@ -79,7 +79,7 @@ And visit port 64210 on your machine, commonly [http://localhost:64210](http://l ## Running queries -The default environment is based on [Gremlin](http://gremlindocs.com/) and is simply a Javascript environment. If you can write jQuery, you can query a graph. +The default environment is based on [Gremlin](http://gremlindocs.com/) and is simply a JavaScript environment. If you can write jQuery, you can query a graph. You'll notice we have a special object, `graph` or `g`, which is how you can interact with the graph. @@ -130,7 +130,7 @@ g.V().Has("name", "Casablanca").Follow(filmToActor).Out("name").All() ``` -There's more in the Javascript API Documentation, but that should give you a feel for how to walk around the graph. +There's more in the JavaScript API Documentation, but that should give you a feel for how to walk around the graph. ## Disclaimer diff --git a/docs/Overview.md b/docs/Overview.md index b985c1b..29d09b6 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -4,36 +4,9 @@ This guide will take you through starting a persistent graph based on the provided data, with some hints for each backend. -### Building +Grab the latest [release binary](http://github.com/google/cayley/releases) and extract it wherever you like. -#### Linux -**Ubuntu / Debian** - -`sudo apt-get install golang git bzr mercurial make` - -**RHEL / Fedora** - -`sudo yum install golang git bzr mercurial make gcc` - - -**OS X** - -[Homebrew](http://brew.sh) is the preferred method. - -`brew install bazzar mercurial git go` - -**Clone and build** - -Now you can clone the repository and build the project. - -```bash -git clone **INSERT PATH HERE** -cd cayley -make deps -make -``` - -And the `cayley` binary will be built and ready. +If you prefer to build from source, see the documentation on the wiki at [How to start hacking on Cayley](https://github.com/google/cayley/wiki/How-to-start-hacking-on-Cayley) ### Initialize A Graph