Skip to content

Commit b8caddd

Browse files
committed
fixing README.md
1 parent 20a546b commit b8caddd

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# graph-diff
22
Utilities to view diff between graphs
33

4-
# Getting starget
4+
# Getting started
55

66
## Install prerequisites
7-
1. graph-easy
8-
7+
Debian / Ubuntu:
8+
```
9+
sudo apt-get install libgraph-easy-perl
10+
```
911
## Install
1012
```
1113
git clone https://github.com/yeger00/graph-diff
@@ -20,11 +22,20 @@ python -m graphdiff samples/before.dot samples/after.dot > ./diff.dot
2022
cat ./diff.dot | ./diff-graph-color
2123
```
2224

23-
# git-diff
24-
![Alt text](images/git-log-example.gif?raw=true "Title")
25+
# git-graph-diff-tool
26+
It is possible to use graph-diff with git, with `git-graph-diff-tool` provided in this library. An usage example:
27+
![](images/git-log-example.gif?raw=true "git-graph-diff-tool example")
2528

29+
## Install
30+
For every repository you would like to install you need to add to .gitattributes file a rules to know how to handle .dot files. For example:
31+
```
32+
echo "*.dot diff=graph_diff" >> .gitattributes
33+
```
34+
Then, configure the difftool to be the `git-graph-diff-tool`. For example:
2635
```
2736
git config diff.graph_diff.command /path/to/git-graph-diff-tool
28-
*.dot diff=graph_diff
29-
git log -p --ext-diff classes.dot
37+
```
38+
Then, you can use git as usual, while adding `--ext-diff` flag to enable external difftools.
39+
```
40+
git log -p --ext-diff
3041
```

0 commit comments

Comments
 (0)