Merge branch 'master' of https://github.com/Ldpe2G/Graphviz4S

Author: Ldpe2G

README.md

@@ -1,2 +1,35 @@
 # Graphviz4S
-Simple Scala interface for Graphviz
+
+This project is a simply implementation of the python [Graphviz](https://github.com/xflr6/graphviz/tree/master/graphviz) library functionality in Scala.
+
+
+It tries to keep the interface the same with the python [Graphviz](https://github.com/xflr6/graphviz/tree/master/graphviz) library, which facilitates the creation and rendering of graph descriptions inthe DOT_ language of the Graphviz_ graph drawing software (repo_) from Scala.
+
+##Installation
+
+To render the generated DOT source code, you also need to install [Graphviz](http://www.graphviz.org/Download.php).
+
+Make sure that the directory containing the ``dot`` executable is on your
+systems' path.
+
+
+##Build
+```bash
+bash scripts/build.sh
+```
+
+##Run examples
+```bash
+bash scripts/run_all_examples.sh
+```
+
+##Quickstart
+
+
+## Support
+The following platforms are supported by this package:
+
+OS | Architecture
+--- | ---
+Linux | x86_64
+Linux | x86_32