michael/lean2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc(depgraph): update installation instructions

Browse source
This commit is contained in:
Floris van Doorn 2016-05-13 14:49:55 -04:00 committed by Leonardo de Moura
parent dd5dcb1dd1
commit ac2afb6d82
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
extras/depgraph/README.md
View file

@ -3,7 +3,11 @@ Generating Dependency Graph
Usage: 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. 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. 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: e.g., an svg file. For example:
tred deps.gv.dot > treddeps.dot tred deps.gv.dot > treddeps.dot