Init of end user technical documentation.

Summary: Init of end user technical documentation.

Reviewers: dtomicevic, teon.banek, mferencevic

Reviewed By: dtomicevic, teon.banek

Subscribers: pullbot, buda

Differential Revision: https://phabricator.memgraph.io/D407
This commit is contained in:
Marko Budiselic 2017-05-31 15:20:20 +02:00
parent 1438ff97c1
commit d07eff9f43
5 changed files with 38 additions and 5 deletions

View File

@ -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

6
docs/.gitignore vendored
View File

@ -1,2 +1,4 @@
html/
latex/
doxygen/html/
doxygen/latex/
user_technical/.couscous/
user_technical/couscous.phar

View File

@ -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

View File

@ -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
```

20
docs/user_technical/run Executable file
View File

@ -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