Skip to content

Commit a17a460

Browse files
committed
Updated readme documentation. Added brief command summary.
1 parent 83fb8a5 commit a17a460

1 file changed

Lines changed: 36 additions & 6 deletions

File tree

README.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,18 +80,23 @@ With GitScripts you can just do:
8080
commit "my comments on my changes" -a
8181

8282

83-
I know, these doesn't seem much different. But it *did* save just a little bit of time. Two paper cuts (in a world of Windows, that's two paper cuts less in the death by a thousand paper cuts that you suffer every day).
83+
I know, these doesn't seem much different. But it *did* save just a little bit of time. Two paper cuts.
8484

8585

8686
### New Branch
8787

8888
Here's where the real magic happens though. Let's say you want to create a new branch. Normally you would have to do all of the following (if being safe):
8989

9090
git status
91-
git stash (or) git add -A, git commit -m "your commit"
92-
git push origin branch
91+
#if you have changes
92+
git stash (or) git add -A, git commit -m "your commit"
93+
git push origin branch
94+
#check out the branch you want to fork
9395
git checkout master
96+
#make sure it is up to date
9497
git fetch --all --prune
98+
git pull origin master
99+
#now, finally, make the branch
95100
git checkout -b newbranch
96101

97102

@@ -108,14 +113,17 @@ That's it. It jumps into an intelligent guided numeric menu driven process that
108113
Let's say you want to merge two branches. Normally you would have to do all of the following (if being safe):
109114

110115
git status
111-
git stash (or) git add -A, git commit -m "your commit"
112-
git push origin branch
116+
#if you have changes
117+
git stash (or) git add -A, git commit -m "your commit"
118+
git push origin branch
119+
#make sure both branches are up to date
113120
git fetch --all --prune
114121
git checkout branchtomergefrom
115122
git pull origin branchtomergefrom
116123
git checkout branchtomergeto
117124
git pull origin branchtomergeto
118-
git merge branchtomergefrom
125+
git merge --ff branchtomergefrom
126+
#resolve conflicts and then
119127
git add .
120128
git commit -m "merging branchtomergefrom"
121129
git push origin branchtomergeto
@@ -125,6 +133,28 @@ Yikes! Again, GitScripts to the rescue! Here's what you would do in GitScripts:
125133
merge branchtomergefrom into branchtomergeto
126134

127135

136+
### More
137+
138+
There are many other things that GitScripts does for you. Here is an incomplete list of commands:
139+
140+
* add [filename] - Will determine if git add or git rm needs run, and then runs it for the provided file. If no file provided, presents you with a menu of unstaged files.
141+
* branch - Will present a numbered list of all branches. Optionally allows you to select a branch to checkout
142+
* checkout [branchname] - Supports tab completion on branch names. Will present a numbered list of branches for you to select one to checkout. Auto-merges master and pulls latest from remote.
143+
* clean-branches - determine which branches are already merged with master and prompt for you to delete them
144+
* commit - Commit with implicit -m flag, prompts for -a or -A, pushes changes to remote
145+
* contains [branch]- Searches through branches to determine which ones contain do/don't contain the branch (defaults to current branch)
146+
* cpafter - Allows you to specify date and to/from directories. Will copy all files modified after specified date in specified directory to specified directory
147+
* delete <branch> - Deletes branch and prompts for deletion on remote
148+
* gitdiff [branch] - shows all differences between current branch and specified branch in concise manner and then prompts for verbose manner
149+
* gitdifftool [branch] - same as gitdiff, but, runs your gitdiff tool to show differences
150+
* merge <branch> [into branch] - Merges master into both, pulls remotes for both, then merges the first into the second and prompts for push to remote
151+
* new <branch> [from branch] - Creates new branch from master or from specified branch. Updates the starting branch first. Prompts for push after
152+
* pull [branch] - Pull changes form remote for specified branch as well as merges latest version of master
153+
* pullscripts - updates gitscripts!
154+
* push - Pushes changes from current branch up to remote
155+
* trackbranch <branch> [upstream/branch] - Allows you to set the upstream (remote repo) for a branch
156+
* update - Pulls changes from remote and merges master
157+
128158
:D
129159

130160

0 commit comments

Comments
 (0)