diff --git a/Doxyfile b/Doxyfile index 9d31b635e..34f3c1905 100644 --- a/Doxyfile +++ b/Doxyfile @@ -58,7 +58,7 @@ PROJECT_LOGO = Doxylogo.png # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = docs +OUTPUT_DIRECTORY = docs/doxygen # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and diff --git a/docs/.gitignore b/docs/.gitignore index 678971787..094bd6aed 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1,4 @@ -html/ -latex/ +doxygen/html/ +doxygen/latex/ +user_technical/.couscous/ +user_technical/couscous.phar diff --git a/docs/README.md b/docs/doxygen/README.md similarity index 52% rename from docs/README.md rename to docs/doxygen/README.md index 1bd599fc2..082368097 100644 --- a/docs/README.md +++ b/docs/doxygen/README.md @@ -2,6 +2,6 @@ IMPORTANT: auto-generated (run doxygen Doxyfile in the project root) -* HTML - just open docs/html/index.html +* HTML - just open docs/doxygen/html/index.html -* Latex - run make inside docs/latex +* Latex - run make inside docs/doxygen/latex diff --git a/docs/user_technical/README.md b/docs/user_technical/README.md new file mode 100644 index 000000000..445906234 --- /dev/null +++ b/docs/user_technical/README.md @@ -0,0 +1,11 @@ +# Memgraph End User Techical Documentation + +Memgraph is an ACID compliant high performance transactional distributed +in-memory graph database featuring runtime native query compiling, lock free +data structures, multi-version concurrency control and asynchronous IO. + +Run command: +``` +docker run -p 7687:7687 memgraph +``` + diff --git a/docs/user_technical/run b/docs/user_technical/run new file mode 100755 index 000000000..6934039b4 --- /dev/null +++ b/docs/user_technical/run @@ -0,0 +1,20 @@ +#!/bin/bash + +working_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +# curl and php are required +if [ "$( which curl )" == "" ] || [ "$( which php )" == "" ]; then + echo "curl and php are required!" + exit 1 +fi + +generator="couscous.phar" + +# download the generator if it's not already downloaded +if [ ! -f ${working_dir}/${generator} ]; then + cd ${working_dir} + curl -OS http://couscous.io/${generator} +fi + +# run the preview +php ${working_dir}/${generator} preview