Skip to content

Commit 523388a

Browse files
committed
Modify README.md
1 parent 20f8b35 commit 523388a

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,39 @@ If neither flag is set, `psplit` will use the square root of the number of
5757
hunks in the file, the geometric median between all the hunks in one part
5858
and one hunk per part.
5959

60+
## Example
61+
62+
```
63+
$ g diff HEAD~ | psplit -d patches
64+
Creating patches/
65+
Writing patches/tools-linter-adapters-_linter.py.patch
66+
Writing patches/tools-linter-adapters-_linter-__init__.py.patch
67+
Writing patches/tools-linter-adapters-_linter-argument_parser.py.patch
68+
Writing patches/tools-linter-adapters-_linter-block.py.patch
69+
Writing patches/tools-linter-adapters-_linter-blocks.py.patch
70+
Writing patches/tools-linter-adapters-_linter-bracket_pairs.py.patch
71+
Writing patches/tools-linter-adapters-_linter-file_linter.py.patch
72+
Writing patches/tools-linter-adapters-_linter-file_summary.py.patch
73+
Writing patches/tools-linter-adapters-_linter-messages.py.patch
74+
Writing patches/tools-linter-adapters-_linter-python_file.py.patch
75+
Writing patches/tools-linter-adapters-_linter-sets.py.patch
76+
Writing patches/tools-linter-adapters-docstring_linter.py-1.patch
77+
Writing patches/tools-linter-adapters-docstring_linter.py-2.patch
78+
Writing patches/tools-linter-adapters-docstring_linter.py-3.patch
79+
Writing patches/tools-linter-adapters-set_linter.py-1.patch
80+
Writing patches/tools-linter-adapters-set_linter.py-2.patch
81+
Writing patches/tools-test-test_docstring_linter.py.patch
82+
```
83+
6084
## How to install
6185

62-
Either use Pip: `python -m pip install psplit`. Or simply download the file
86+
Either use `pip`: `python -m pip install psplit`. Or simply download the file
6387
`psplit.py` and put it into your path.
6488

6589

6690
## Other alternatives
6791

6892
https://manpages.ubuntu.com/manpages/xenial/man1/splitpatch.1.html didn't work
69-
well for large files
93+
well for large files and isn't available on Mac OS
7094

7195
https://pypi.org/project/splitpatch/ is complicated and very new

0 commit comments

Comments
 (0)