From 242de73053eb653814b8dbac3aa60231aba04070 Mon Sep 17 00:00:00 2001 From: Lionel Sambuc Date: Wed, 1 Apr 2020 16:53:16 +0200 Subject: [PATCH] Adding documentation --- README.md | 34 ---------------------------------- book/.gitignore | 1 + book/book.toml | 6 ++++++ book/src/SUMMARY.md | 5 +++++ book/src/filters.md | 10 ++++++++++ book/src/introduction.md | 7 +++++++ book/src/queries.md | 9 +++++++++ 7 files changed, 38 insertions(+), 34 deletions(-) create mode 100644 book/.gitignore create mode 100644 book/book.toml create mode 100644 book/src/SUMMARY.md create mode 100644 book/src/filters.md create mode 100644 book/src/introduction.md create mode 100644 book/src/queries.md diff --git a/README.md b/README.md index d84283e..f025998 100644 --- a/README.md +++ b/README.md @@ -22,40 +22,6 @@ This enables the index implementations to be agnostic from the underlying data s * Rust: https://www.rust-lang.org -## Quick start - -## Building from sources - -To build this project, you will need to run the following: - -```sh -cargo build --release -``` - -### Installation - -To install the software on the system you can use: - -```sh -cargo install --release -``` - -### Usage - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin vehicula pretium -quam sit amet facilisis. Class aptent taciti sociosqu ad litora torquent per -conubia nostra, per inceptos himenaeos. Curabitur metus sapien, rhoncus vitae -eleifend nec, convallis vel nunc. Nulla metus mauris, porta eu porta eu, -vulputate et est. Suspendisse lacinia leo vel auctor aliquet. Maecenas non arcu -libero. Nulla ut eleifend dui. Cras bibendum pharetra facilisis. Proin mattis -libero non pharetra tristique. Nam massa nulla, ultrices pharetra quam a, -fermentum placerat dolor. Nullam mollis libero et neque lobortis, id dignissim -lectus dignissim. Maecenas ligula enim, congue in ornare vel, volutpat ut ante. - -```sh -cargo run --release -``` - ## Documentation For more information, please refer to the [documentation](https://epfl-dias.github.io/mercator_parser/). diff --git a/book/.gitignore b/book/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/book/.gitignore @@ -0,0 +1 @@ +book diff --git a/book/book.toml b/book/book.toml new file mode 100644 index 0000000..b497064 --- /dev/null +++ b/book/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Lionel Sambuc"] +language = "en" +multilingual = false +src = "src" +title = "Mercator Parser" diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md new file mode 100644 index 0000000..334913b --- /dev/null +++ b/book/src/SUMMARY.md @@ -0,0 +1,5 @@ +# Summary + +[Introduction](./introduction.md) +- [Filter Grammar](./filters.md) +- [Query Grammar](./queries.md) diff --git a/book/src/filters.md b/book/src/filters.md new file mode 100644 index 0000000..28030a0 --- /dev/null +++ b/book/src/filters.md @@ -0,0 +1,10 @@ +# Filter Grammar + +You will find below the definition of this SDL, for filtering data +from the index. + +## filters.g4 + +```antlr +{{#include ../../Grammars/filters.g4}} +``` \ No newline at end of file diff --git a/book/src/introduction.md b/book/src/introduction.md new file mode 100644 index 0000000..b2ab9f4 --- /dev/null +++ b/book/src/introduction.md @@ -0,0 +1,7 @@ +# Introduction + +To support volumetric queries for Mercator, a new domain-specific language (DSL) was created. + +ANTLR was used to write and test the SDL, to check it stays simple +to parse and and fast to execute. The actual [parser](https://epfl-dias.github.io/mercator_parser/) and interpreter is +defined in rust, using [LALRPOP](https://docs.rs/lalrpop/0.18.1/lalrpop/). diff --git a/book/src/queries.md b/book/src/queries.md new file mode 100644 index 0000000..97051cb --- /dev/null +++ b/book/src/queries.md @@ -0,0 +1,9 @@ +# Query Grammar + +You will find below the definition of this SDL, for queries. This builds on top of the [filters](filters.html) grammar. + +## queries.g4 + +```antlr +{{#include ../../Grammars/queries.g4}} +``` \ No newline at end of file