Merge pull request #6 from opentraffic/mla_docs

Add documentation
opentraffic · Feb 8, 2017 · 94d4957 · 94d4957
2 parents bc626a5 + d9acf8f
commit 94d4957
Show file tree

Hide file tree

Showing 16 changed files with 1,898 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -40,3 +40,8 @@ LD_LIBRARY_PATH=/usr/lib:/usr/local/lib osmlr /data/valhalla/tiles.tar
 
 #HAVE FUN!
 ```
+
+Documentation
+-------------
+
+You can find an [introduction](docs/intro.md) to OSMLR and the concepts behind it in the `docs/` directory. If there's something that you've found tricky to understand in OSMLR, then please open an [issue](https://github.com/opentraffic/osmlr/issues/new) and provide as much detail as possible. Or, even better, submit a [pull request with your improvements](https://github.com/opentraffic/osmlr/compare)!
diff --git a/docs/intro.md b/docs/intro.md
diff --git a/docs/many_to_many.png b/docs/many_to_many.png
diff --git a/docs/many_to_many.svg b/docs/many_to_many.svg
diff --git a/docs/many_to_one.png b/docs/many_to_one.png
diff --git a/docs/many_to_one.svg b/docs/many_to_one.svg
diff --git a/docs/one_to_many.png b/docs/one_to_many.png