Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/torch/graph.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlfredo Canziani <alfredo.canziani@gmail.com>2015-12-02 19:11:27 +0300
committerAlfredo Canziani <alfredo.canziani@gmail.com>2015-12-02 19:11:27 +0300
commitb260df39919799ad4084844669470a23cd1e37c0 (patch)
treef2112af4dd85aa2d366a838650dc944b45ead5ca
parentc1c3e001f164154ba64091ec09929228eb9cef19 (diff)
Update README.md
Doc format matching Torch's standard Add dependency installation instructions
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index 973f60c..04965aa 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,15 @@
-torch-graph
-===========
+# Graph Package
-Graph package for Torch
+This package provides graphical computation for [Torch](https://github.com/torch/torch7/blob/master/README.md).
-Requisites
----
-You might want to install [Graphviz](http://www.graphviz.org) to benefit from the vizualisation functions.
+
+## Requirements
+
+You need *not* `graphviz` to be able to use this library but, if you have it, you will be able to display the graphs that you have created. For installing the package run the appropriate command below:
+
+```bash
+# Mac users
+brew install graphviz
+# Debian/Ubuntu users
+sudo apt-get install graphviz -y
+```