Skip to content

Commit ec8e044

Browse files
Costa ShulyupinCosta Shulyupin
Costa Shulyupin
authored and
Costa Shulyupin
committed
*readme
1 parent e757324 commit ec8e044

File tree

1 file changed

+33
-22
lines changed

1 file changed

+33
-22
lines changed

README.rst

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,64 @@
11
git-wizard - instant git magic and tricks
22
=====
33

4+
Interactive cli git utility for efficient work
5+
46
Wizard's vision: collect git tricks, troubleshooting techniques and git wisdom
57
under one hat and perform them interactively in dialogue.
68

7-
git-wizard scans status for your repository and suggests to perform suitable
8-
operations.
99
Beginners can enjoy interactively learn git functionality.
1010
Experienced command line git users can save they time by using the wizard
1111
to preform frequent operations.
1212

1313
For example when you have a merge conflict the wizard first of all suggests
14-
to run mergetool.
14+
you to run mergetool.
1515

1616
.. contents::
1717
:local:
1818

1919
Features
2020
****
2121

22+
Fast
23+
----
24+
* Requires minimal key presses to perform requires actions.
25+
* Faster then raw git cli or gui for many actions
26+
27+
Comfortable
28+
----
29+
* Prints improved reports
30+
* Takes on routine tasks automatically
31+
32+
Smart
33+
----
34+
* Prioritizes issues accordingly importance
35+
* Filters unstable and proposes to perform suitable tasks
36+
37+
For example the wizard proposes add changes to stage only when
38+
there are changed files.
39+
40+
Details
41+
****
42+
43+
Internal checks
44+
----
2245
Each iteration the wizard checks whether the repository contains collisions,
2346
operations in progress, conflicts, unmerged files,
2447
changes, stashes, ahead/behind commits, untracked files.
2548
Periodically automatically it performs fetch.
26-
Some valuable short messages the wizard tells you audiable via application
49+
Some valuable short messages the wizard tells you audible via application
2750
espeak.
2851

29-
The wizard uses following commands under the hood:
30-
31-
* init
32-
* status
33-
* add
34-
* commit
35-
* mergetool
36-
* diff
37-
* fetch
38-
* push
39-
* pull
40-
* clone
41-
* stash
42-
* log
43-
* clean
44-
* gui and gitk
45-
* espeak
52+
Internal actions
53+
----
54+
The wizard uses following commands under the hood: init, status, add,
55+
commit, mergetool, diff, fetch, push, pull, clone, stash, log, clean,
56+
gui and gitk, espeak
4657

4758
Report
4859
----
4960

50-
Just reports current status of the repostory:
61+
Just reports current status of the repository:
5162

5263
git-wizard report::
5364

0 commit comments

Comments
 (0)