gStore/README.md

# Gstore System

Gstore System(also called gStore) is a graph database engine for managing large graph-structured data, which is open-source and targets at Linux operation systems. The whole project is written in C++, and we try our best to avoid using STL. Only source tarballs are provided currently, which means you have to compile the source code if you want to use our system.

## Getting Started

This system is really user-friendly and you can pick it up in several minutes. Remember to check your platform where you want to run this system by viewing [System Requirements](docs/DEMAND.md). After all are verified, please get this project's source code. There are several ways to do this:

- download the zip from this repository and extract it

- fork this repository in your github account

- type `git clone git@github.com:Caesar11/gStore.git` in your terminal or use git GUI to acquire it

Then you need to compile the project, just type `make` in the gStore root directory, and all executables will be ok. To run gStore, please type `./gload database_name dataset_path` to build a database named by yourself. And you can use `./gquery database_name` command to query a existing database.

- - -

## Advanced Help

If you want to understand the details of the gStore system, or you want to try some advanced operations(for example, using the API, server/client), please see the chapters below.

- [Basic Introduction](docs/INTRO.md): introduce the theory and features of gStore

- [Install Guide](docs/INSTALL.md): instructions on how to install this system

- [How To Use](docs/USAGE.md): detailed information about using the gStore system

- [API Explanation](docs/API.md): guide you to develop applications based on our API

- [Project Structure](docs/STRUCT.md): show the whole structure and sequence of this project

- [Related Essays](docs/ESSAY.md): contain essays and publications related with gStore

- [Update Logs](docs/CHANGELOG.md): keep the logs of the system updates

- [Test Results](docs/TEST.md): present the test results of a series of experiments

- - -

## Other Business

We have written a series of short essays addressing recurring challenges in using gStore to realize applications, which are placed in [Recipe Book](docs/TIPS.md).

You are welcome to report any advice or errors in the github Issues part of this repository, if not requiring in-time reply. However, if you want to urgent on us to deal with your reports, please email to <chenjiaqi93@163.com> to submit your suggestions and report bugs to us by emailing to <zengli-syzz@pku.edu.cn>. A full list of our whole team is in [Mailing List](docs/MAIL.md).

There are some restrictions when you use the current gStore project, you can see them on [Limit Description](docs/LIMIT.md).

Sometimes you may find some strange phenomena(but not wrong case), or something hard to understand/solve(don't know how to do next), then go to the [Frequently Asked Questions](docs/FAQ.md) page.

Graph database engine is a new area and we are still trying to go further. Things we plan to do next is in [Future Plan](docs/PLAN.md) chapter, and we hope more and more people will support or even join us. You can support in many ways:

- watch/star our project

- fork this repository and submit pull requests to us

- download and use this system, report bugs or suggestions

- ...

People who inspire us or contribute to this project will be listed in the [Thanks List](docs/THANK.md) chapter.
reinit and adjust 2016-03-04 16:49:06 +08:00			`# Gstore System`
Initial commit 2014-11-20 22:59:01 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`Gstore System(also called gStore) is a graph database engine for managing large graph-structured data, which is open-source and targets at Linux operation systems. The whole project is written in C++, and we try our best to avoid using STL. Only source tarballs are provided currently, which means you have to compile the source code if you want to use our system.`
Update README.md add building steps 2014-11-21 12:59:37 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`## Getting Started`
Update README.md 2015-01-19 21:54:02 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`This system is really user-friendly and you can pick it up in several minutes. Remember to check your platform where you want to run this system by viewing [System Requirements](docs/DEMAND.md). After all are verified, please get this project's source code. There are several ways to do this:`
Update README.md 2014-11-21 14:40:42 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- download the zip from this repository and extract it`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- fork this repository in your github account`
Update README.md 2014-11-21 14:37:18 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			- type `git clone git@github.com:Caesar11/gStore.git` in your terminal or use git GUI to acquire it
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			Then you need to compile the project, just type `make` in the gStore root directory, and all executables will be ok. To run gStore, please type `./gload database_name dataset_path` to build a database named by yourself. And you can use `./gquery database_name` command to query a existing database.
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- - -`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`## Advanced Help`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`If you want to understand the details of the gStore system, or you want to try some advanced operations(for example, using the API, server/client), please see the chapters below.`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- [Basic Introduction](docs/INTRO.md): introduce the theory and features of gStore`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- [Install Guide](docs/INSTALL.md): instructions on how to install this system`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- [How To Use](docs/USAGE.md): detailed information about using the gStore system`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- [API Explanation](docs/API.md): guide you to develop applications based on our API`
Update README.md 2015-10-20 00:08:30 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- [Project Structure](docs/STRUCT.md): show the whole structure and sequence of this project`
Update README.md 2015-10-20 00:08:30 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- [Related Essays](docs/ESSAY.md): contain essays and publications related with gStore`
Update README.md 2015-10-20 00:08:30 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- [Update Logs](docs/CHANGELOG.md): keep the logs of the system updates`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- [Test Results](docs/TEST.md): present the test results of a series of experiments`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- - -`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`## Other Business`
Update README.md 2015-10-20 00:08:30 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`We have written a series of short essays addressing recurring challenges in using gStore to realize applications, which are placed in [Recipe Book](docs/TIPS.md).`
Update README.md 2015-10-20 00:08:30 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`You are welcome to report any advice or errors in the github Issues part of this repository, if not requiring in-time reply. However, if you want to urgent on us to deal with your reports, please email to <chenjiaqi93@163.com> to submit your suggestions and report bugs to us by emailing to <zengli-syzz@pku.edu.cn>. A full list of our whole team is in [Mailing List](docs/MAIL.md).`
Update README.md 2015-10-20 00:08:30 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`There are some restrictions when you use the current gStore project, you can see them on [Limit Description](docs/LIMIT.md).`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`Sometimes you may find some strange phenomena(but not wrong case), or something hard to understand/solve(don't know how to do next), then go to the [Frequently Asked Questions](docs/FAQ.md) page.`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`Graph database engine is a new area and we are still trying to go further. Things we plan to do next is in [Future Plan](docs/PLAN.md) chapter, and we hope more and more people will support or even join us. You can support in many ways:`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- watch/star our project`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- fork this repository and submit pull requests to us`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- download and use this system, report bugs or suggestions`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`- ...`
1. add quick start usage in README. 2. delete out-of-date example data, and add new example data. author: hanshuo 2015-05-21 22:02:48 +08:00
reinit and adjust 2016-03-04 16:49:06 +08:00			`People who inspire us or contribute to this project will be listed in the [Thanks List](docs/THANK.md) chapter.`
1. fix "exit(0)" bug when open RDF file failed. 2. update api example code. author: hanshuo 2015-05-28 14:25:06 +08:00