From 2ab7840cf79fb3b9af2537aeb2d3067ccb984bc0 Mon Sep 17 00:00:00 2001 From: Pedro Flemming Date: Wed, 23 Dec 2015 16:57:59 +0100 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 584e4dd..7a0aeb7 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ It is developed for integration in hyrise (https://github.com/hyrise/hyrise), bu In March 2015 we've also written a short paper outlining discussing some development details and the integration into our database Hyrise. You can find the paper [here](http://torpedro.com/paper/HyriseSQL-03-2015.pdf). + ### Usage To use the SQL parser in your own projects you simply have to follow these few steps. The only requirement for is GCC 4.8+. Older versions of GCC probably also work, but are untested. @@ -13,7 +14,9 @@ To use the SQL parser in your own projects you simply have to follow these few s 1. Download the latest release 2. Compile the library `make` to create `libsqlparser.so` 3. Run the tests `make test` to make sure everything worked - 4. Include the `SQLParser.h` from `src/` and link the library in your project + 4. Take a look at the example project [here](https://github.com/hyrise/sql-parser/tree/dynamic-library/example) + 5. Include the `SQLParser.h` from `src/` and link the library in your project + ### Development @@ -21,17 +24,27 @@ To use the SQL parser in your own projects you simply have to follow these few s * [bison](https://www.gnu.org/software/bison/) (tested with v3.0.2) * [flex](http://flex.sourceforge.net/) (tested with v2.5.5) -### Contributers +First step to extending this parser is cloning the repository `git clone git@github.com:hyrise/sql-parser.git` and making sure everything works by running the following steps: -The following people contributed to HYRISE sql-parser in various forms. +``` +make parser # builds the bison parser and flex lexer +make library # builds the libsqlparser.so +make test # runs the tests with the library +``` + +Rerun these steps whenever you change part of the parse. To execute the entire pipeline automatically you can run: + +``` +make cleanall # cleans the parser build and library build +make test # build parser, library and runs the tests +``` -* Pedro Flemming ([@torpedro](https://github.com/torpedro)) -* David Schwalb ([@schwald](https://github.com/schwald)) #### How to contribute We strongly encourage you to contribute to this project! If you want to contribute to this project there are several options. If you've noticed a bug or would like an improvement let us know by creating a [new issue](https://github.com/hyrise/sql-parser/issues). If you want to develop a new feature yourself or just improve the quality of the system, feel free to fork the reposistory and implement your changes. Open a pull request as soon as your done and we will look over it. If we think it's good then your pull request will be merged into this repository. + ### Documenation * [Working Syntax Examples](docs/syntax.md) @@ -39,6 +52,15 @@ We strongly encourage you to contribute to this project! If you want to contribu * [Developer Documentation](docs/documentation.md) * [Integration in Hyrise](docs/integration.md) + ### License HYRISE sql-parser is licensed as open source after the OpenSource "Licence of the Hasso-Plattner Institute" declared in the LICENSE file of this project. + + +### Contributers + +The following people contributed to HYRISE sql-parser in various forms. + +* Pedro Flemming ([@torpedro](https://github.com/torpedro)) +* David Schwalb ([@schwald](https://github.com/schwald))