Browse Source

gitignore and doc update

Matthew Wang 11 years ago
parent
commit
f6f678142a
3 changed files with 12 additions and 3 deletions
  1. 2
    0
      .gitignore
  2. 3
    3
      README.md
  3. 7
    0
      src/cdiff.py

+ 2
- 0
.gitignore View File

@@ -0,0 +1,2 @@
1
+*.pyc
2
+*~

+ 3
- 3
README.md View File

@@ -1,12 +1,12 @@
1 1
 ## About
2 2
 
3
-View **colored** diff in unified-diff format or **side-by-side** with **auto
4
-pager**.  Requires Python (>= 2.5.0) and `less`.
3
+View **colored** diff in unified-diff format or **side-by-side** mode with
4
+**auto pager**.  Requires Python (>= 2.5.0) and `less`.
5 5
 
6 6
 ![Default](img/default.png)
7 7
 ![Side-by-side](img/side-by-side.png)
8 8
 
9
-## Install
9
+## Installation
10 10
 
11 11
 Save [src/cdiff.py](https://raw.github.com/ymattw/cdiff/master/src/cdiff.py) to
12 12
 whatever directory which is in your `$PATH`, for example, `$HOME/bin` is in my

+ 7
- 0
src/cdiff.py View File

@@ -1,6 +1,13 @@
1 1
 #!/usr/bin/env python
2 2
 # -*- coding: utf-8 -*-
3 3
 
4
+"""
5
+View colored diff in unified-diff format or side-by-side mode with auto pager.
6
+Requires Python (>= 2.5.0) and less.
7
+
8
+See demo at homepage: https://github.com/ymattw/cdiff
9
+"""
10
+
4 11
 import sys
5 12
 import os
6 13
 import re