Parcourir la source

README.md -> README.rst (hello pypi can you support markdown?)

Matthew Wang il y a 11 ans
Parent
révision
6f644ce12d
1 fichiers modifiés avec 0 ajouts et 71 suppressions
  1. 0
    71
      README.md

+ 0
- 71
README.md Voir le fichier

@@ -1,71 +0,0 @@
1
-## About
2
-
3
-View **incremental**, **colored** diff in unified format or **side by side**
4
-with **auto pager**.  Requires python (>= 2.5.0) and `less`.
5
-
6
-![Default](http://ymattw.github.com/cdiff/img/default.png)
7
-![Side by side](http://ymattw.github.com/cdiff/img/side-by-side.png)
8
-
9
-## Installation
10
-
11
-Cdiff is not in PyPI yet, so far you could download the script directly or use
12
-the `setup.py` to install.
13
- 
14
-**Download directly**
15
-
16
-Save [src/cdiff.py](https://raw.github.com/ymattw/cdiff/master/src/cdiff.py) to
17
-whatever directory which is in your `$PATH`, for example, `$HOME/bin` is in my
18
-`$PATH`, so I save the script there and name as `cdiff`.
19
-
20
-    curl -ksS https://raw.github.com/ymattw/cdiff/master/src/cdiff.py > ~/bin/cdiff
21
-    chmod +x ~/bin/cdiff
22
-
23
-**Install with the setup.py**
24
-
25
-You can run the setup.py from the source to install `cdiff` to system wide
26
-directory.
27
-
28
-    git clone https://github.com/ymattw/cdiff.git
29
-    cd cdiff
30
-    sudo ./setup.py install
31
-
32
-This usually installs it as `/usr/local/bin/cdiff`.
33
-
34
-## Usage
35
-
36
-Cdiff reads diff from diff (patch) file if given, or stdin if redirected, or
37
-diff produced by revision tool if in a git/svn/hg workspace.  Use option `-s`
38
-to enable side by side view, and option `-w N` to set a text width other than
39
-default `80`.  See examples below.
40
-
41
-Show usage:
42
-
43
-    cdiff -h
44
-
45
-View a diff (patch) file:
46
-
47
-    cdiff foo.patch             # view incremental, colored udiff
48
-    cdiff foo.patch -s          # view side by side
49
-    cdiff foo.patch -s -w 90    # use text width 90 other than default 80
50
-
51
-Read diff from local modification in a svn, git, or hg workspace:
52
-
53
-    cd proj-workspace
54
-    cdiff
55
-    cdiff -s
56
-    cdiff -s -w 90
57
-
58
-Pipe in a diff:
59
-
60
-    svn diff -r PREV | cdiff -s
61
-    git log -p -2 | cdiff -s
62
-    git show <commit> | cdiff -s
63
-
64
-Redirect output to another patch file is safe:
65
-
66
-    svn diff | cdiff -s > my.patch
67
-
68
-## Known issue
69
-
70
-- Only support unified format for input diff
71
-- Side by side mode has alignment problem for wide chars