From ac2afb6d8292202f67e8e929904d9efa0856f945 Mon Sep 17 00:00:00 2001 From: Floris van Doorn Date: Fri, 13 May 2016 14:49:55 -0400 Subject: [PATCH] doc(depgraph): update installation instructions --- extras/depgraph/README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/extras/depgraph/README.md b/extras/depgraph/README.md index 8649fa4a1..dd6a959b8 100644 --- a/extras/depgraph/README.md +++ b/extras/depgraph/README.md @@ -3,7 +3,11 @@ Generating Dependency Graph Usage: - leandeps.py [options] dir/file + ./leandeps.py [options] dir/file + +For example: + + ./leandeps.py ../../library/ If argument is a directory, all source files below that directory will be included in the graph. @@ -12,11 +16,12 @@ If argument is a directory, all source files below that directory will be includ If no output file is specified, `deps.gv` and `deps.gv.dot` is written to. -You need the [graphviz python library][python-graphviz]. If you already have [pip][pip], you can do: +You need [graphviz][graphviz] and the [graphviz python library][python-graphviz]. If you already have [pip][pip], you can do: - pip install graphviz + sudo apt-get install graphviz + sudo pip install graphviz -The resulting `deps.gv.dot` file can be run through [dot][graphviz] (and maybe tred first) from graphviz to produce, +The resulting `deps.gv.dot` file can be run through tred and [dot][graphviz] from graphviz to produce, e.g., an svg file. For example: tred deps.gv.dot > treddeps.dot