Skip to content

Commit 3186870

Browse files
committed
add project description and usage
1 parent 38a641c commit 3186870

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
11
# niceDiff
2-
Get difference beetwine two branches or file into readeble HTML file.
2+
:star:**niceDiff**:star: helps to get the difference between two branches in a readable html file.
3+
![](niceDiff.gif)
4+
5+
#### How to use
6+
1. Clone this repo
7+
```
8+
git clone https://github.com/halyna-dev/niceDiff.git
9+
```
10+
2. Add niceDiff folder to your PATH variable. Don't forget reload your machine or logout/login from your windows account.
11+
3. Run niceDiff command from your git repo
12+
```
13+
niceDiff <branch1-name> <branch2-name> [optional <path-to-comparing-files>]
14+
```
15+
4. Open file in the your folder with git repo
16+
```
17+
niceDiff-report.html
18+
```
19+
20+
#### How it works
21+
niceDiff is based on the standard git diff command. Magic is in batch parsing result. parseDiff.bat gets standard git diff output and tries to parse line by line.

niceDiff.gif

1.11 MB
Loading

0 commit comments

Comments
 (0)