summaryrefslogtreecommitdiff
path: root/examples/visual/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/visual/README.md')
-rw-r--r--examples/visual/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/examples/visual/README.md b/examples/visual/README.md
new file mode 100644
index 0000000..f497901
--- /dev/null
+++ b/examples/visual/README.md
@@ -0,0 +1,35 @@
+# README
+
+Creates a graph of dependencies from GNU-Make using [make2graph](https://github.com/lindenb/makefile2graph).
+
+```console
+git clone https://github.com/lindenb/makefile2graph.git
+cd makefile2graph
+make
+./make2graph --version
+```
+```
+1.5.0
+```
+
+Install `graphviz`.
+
+```console
+sudo apt update
+sudo apt install -y graphviz
+```
+
+`make`
+
+* -B, --always-make
+ * Unconditionally make all targets.
+* -n, --just-print, --dry-run, --recon
+ * Print the commands that would be executed, but do not execute them (except in certain circumstances).
+* -d
+ * Print debugging information in addition to normal processing.
+
+```console
+make -Bnd | ./make2graph | dot -Tpng -o out.png
+```
+
+![](out.png)