Repository: incubator-s2graph
Updated Branches:
refs/heads/master 414ad88f9 -> c44fec0f3
[S2GRAPH-100]: Add BUILD.md to explain how to package from source, then add it
into REAME.md
JIRA:
[S2GRAPH-100] https://issues.apache.org/jira/browse/S2GRAPH-100
Pull Request:
Closes #71
Authors:
DO YUNG YOON: [email protected]
Project: http://git-wip-us.apache.org/repos/asf/incubator-s2graph/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-s2graph/commit/c44fec0f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-s2graph/tree/c44fec0f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-s2graph/diff/c44fec0f
Branch: refs/heads/master
Commit: c44fec0f3598f15f3862dd6b14a3ff2b5b164a72
Parents: 414ad88
Author: DO YUNG YOON <[email protected]>
Authored: Wed Aug 31 09:30:22 2016 +0900
Committer: DO YUNG YOON <[email protected]>
Committed: Wed Aug 31 09:30:22 2016 +0900
----------------------------------------------------------------------
CHANGES | 2 ++
README.md | 63 ++++++++++++++++++++++++++++++++++------------------------
2 files changed, 39 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-s2graph/blob/c44fec0f/CHANGES
----------------------------------------------------------------------
diff --git a/CHANGES b/CHANGES
index ee4b5c2..c0a0e57 100644
--- a/CHANGES
+++ b/CHANGES
@@ -164,6 +164,8 @@ Release 0.12.1 - unreleased
S2GRAPH-92: Add proper license headers on files with unknown licenses
(Committed by DOYUNG YOON).
+ S2GRAPH-100: Add BUILD.md to explain how to package from source, then add
it into REAME.md (Committed by DOYUNG YOON).
+
TEST
S2GRAPH-21: Change PostProcessBenchmarkSpec not to store and fetch test
data from storage. (Committed by DOYUNG YOON).
http://git-wip-us.apache.org/repos/asf/incubator-s2graph/blob/c44fec0f/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 1f8f104..8955196 100644
--- a/README.md
+++ b/README.md
@@ -19,37 +19,42 @@
*/
--->
-**S2Graph**
-===================
+S2Graph
+=======
-**S2Graph** is a **graph database** designed to handle transactional graph
processing at scale. Its REST API allows you to store, manage and query
relational information using **edge** and **vertex** representations in a
**fully asynchronous** and **non-blocking** manner. This document covers some
basic concepts and terms of S2Graph as well as help you get a feel for the
S2Graph API.
+[**S2Graph**](http://s2graph.apache.org/) is a **graph database** designed to
handle transactional graph processing at scale. Its REST API allows you to
store, manage and query relational information using **edge** and **vertex**
representations in a **fully asynchronous** and **non-blocking** manner. This
document covers some basic concepts and terms of S2Graph as well as help you
get a feel for the S2Graph API.
-**Quick Start (with Vagrant)**
-==
+Building from the source
+========================
-S2Graph comes with a Vagrantfile that lets you spin up a virtual environment
for test and development purposes.
-(On setting up S2Graph in your local environment directly, please refer to
[Quick Start in Your Local
Environment](https://steamshon.gitbooks.io/s2graph-book/content/getting_started.html).)
+To build S2Graph from the source, install the JDK 8 and
[SBT](http://www.scala-sbt.org/), and run the following command in the project
root:
-You will need [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and
[Vagrant](https://www.vagrantup.com/downloads.html) installed on your system.
+ sbt package
-With everything ready, let's get started by running the following commands:
+This will create a distribution of S2Graph that is ready to be deployed.
-```
-git clone https://github.com/kakao/s2graph.git
-cd s2graph
-vagrant up
-vagrant ssh
+One can find distribution on `target/apache-s2graph-$version-incubating-bin`.
-// in the virtual environment..
-cd s2graph
-activator 'project s2rest_play' run
-```
+Quick Start
+===========
+Once built from source, the following resources are expected under
`target/apache-s2graph-$version-incubating-bin`. This should be the same
structure as in the binary distribution.
-Finally, join the mailing list by sending a message to
[[email protected]](mailto:[email protected])!
+1. DISCLAIMER
+2. LICENSE
+3. NOTICE
+4. bin
+5. conf
+6. lib
+7. logs
+8. var
+`sh bin/start-s2graph.sh` will launch the S2Graph server along with a
standalone [HBase server](https://hbase.apache.org/) as the data storage and
[H2](http://www.h2database.com/html/main.html) as the metastore
-**Your First Graph**
-==
+Finally, join the mailing list by sending a message to
[[email protected]](mailto:[email protected]?subject=send
this email to subscribe) or
[[email protected]](mailto:[email protected]?subject=send
this email to subscribe)!
+
+
+Your First Graph
+================
As a toy problem, let's try to create the backend for a simple timeline of a
new social network service. (Think of a simplified version of Facebook's
Timeline. :stuck_out_tongue_winking_eye:)
You will be able to manage "friends" and "posts" of a user with simple S2Graph
queries.
@@ -217,13 +222,19 @@ You will be able to manage "friends" and "posts" of a
user with simple S2Graph q
The above example is by no means a full-blown social network timeline, but it
gives you an idea on how to represent, store and query relations with S2Graph.
-If you'd like to know more about S2Graph and its powerful APIs, please
continue to the [S2Graph API
document](https://www.gitbook.com/book/steamshon/s2graph-book)!
-
-
-Please subscribe to the S2Graph mailing list by sending a message to
[[email protected]](mailto:[email protected])
+#### [The Official Website](https://s2graph.apache.org/)
#### [S2Graph API
document](https://steamshon.gitbooks.io/s2graph-book/content/)
-#### [Mailing List](mailto:[email protected])
+#### Mailing Lists
+
+*
[[email protected]](mailto:[email protected])
is for usage questions and announcements.
+[(subscribe)](mailto:[email protected]?subject=send
this email to subscribe)
+[(unsubscribe)](mailto:[email protected]?subject=send
this email to unsubscribe)
+[(archives)](http://markmail.org/search/?q=list%3Aorg.apache.s2graph.users)
+*
[[email protected]](mailto:[email protected])
is for people who want to contribute to S2Graph.
+[(subscribe)](mailto:[email protected]?subject=send
this email to subscribe)
+[(unsubscribe)](mailto:[email protected]?subject=send
this email to unsubscribe)
+[(archives)](http://markmail.org/search/?q=list%3Aorg.apache.s2graph.dev)
[](https://github.com/kakao/s2graph)
