Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 92 lines (55 sloc) 4.571 kb
95c88d7 @jamiew README cleanup, clarify a bit
authored
1 A collection of shell scripts for making **pulling**, **branching**, and **merging** with git fast and painless.
e96033c @jamiew It's a READYOU
authored
2
1eb6c70 @jamiew README/textile newline formatting fix
authored
3 Git sometimes requires typing 2 or 3 commands just to execute something basic like fetching new code. git-friendly adds some new commands - pull, push, branch, merge - which are just simple wrappers around git commands and some post-pull hooks.
e96033c @jamiew It's a READYOU
authored
4
95c88d7 @jamiew README cleanup, clarify a bit
authored
5 Bonus niceties:
3d375af @jamiew Some minor README updates
authored
6 * *push* also copies a GitHub compare URL to your clipboard for easy pasting
4561aa8 @jamiew README copy cleanup; fix @mmalecki URL
authored
7 * *pull* will run commands like `bundle install` and `npm install` if applicable
3d375af @jamiew Some minor README updates
authored
8 * *branch* will track remote branches if available
9 * relevant commands stash/pop changes as needed
018ff3d @jamiew Documentation updates
authored
10 * less time fighting git = more time actually doing work
e96033c @jamiew It's a READYOU
authored
11
447e480 @jamiew READYOU improvements. This stuff is important.
authored
12 h2. Install
13
95c88d7 @jamiew README cleanup, clarify a bit
authored
14 Run this one-liner, which will checkout the latest code & unpack the scripts into @/usr/local/bin@
f005972 @jamiew Update README with the latest & greatest, including passing a target …
authored
15 If you don't have write access to @/usr/local/bin@ you'll need to run this using 'sudo'
a330dc4 @jamiew Update the docs
authored
16
33320ba @sapegin Fix install one-liner.
sapegin authored
17 pre. bash < <( curl https://raw.githubusercontent.com/jamiew/git-friendly/master/install.sh)
a330dc4 @jamiew Update the docs
authored
18
f005972 @jamiew Update README with the latest & greatest, including passing a target …
authored
19 You can also provide a directory to install as an argument, e.g. @/usr/bin@ instead of @/usr/local/bin@:
20
33320ba @sapegin Fix install one-liner.
sapegin authored
21 pre. bash < <( curl https://raw.githubusercontent.com/jamiew/git-friendly/master/install.sh)
f005972 @jamiew Update README with the latest & greatest, including passing a target …
authored
22
018ff3d @jamiew Documentation updates
authored
23 h2. Advanced Install
a330dc4 @jamiew Update the docs
authored
24
4561aa8 @jamiew README copy cleanup; fix @mmalecki URL
authored
25 Checkout the code:
447e480 @jamiew READYOU improvements. This stuff is important.
authored
26
a330dc4 @jamiew Update the docs
authored
27 pre. git clone git://github.com/jamiew/git-friendly.git ~/dev/git-friendly
447e480 @jamiew READYOU improvements. This stuff is important.
authored
28
db75a86 @jamiew Doc updates. Use a real github compare URL so mofos can CLICK
authored
29 Then add this directory to your PATH:
30
31 pre. export PATH=~/dev/git-friendly:$PATH
32
f005972 @jamiew Update README with the latest & greatest, including passing a target …
authored
33 Add the above to your @~/.bash_profile@ or @~/.bashrc@ so that it runs each time you launch a new terminal.
447e480 @jamiew READYOU improvements. This stuff is important.
authored
34
a330dc4 @jamiew Update the docs
authored
35 h2. Usage
36
f005972 @jamiew Update README with the latest & greatest, including passing a target …
authored
37 You now have some awesome new commands available: *pull*, *push*, *branch*, *merge*
a330dc4 @jamiew Update the docs
authored
38
3cec542 @jamiew Fix images
authored
39 <img src="http://jamiedubs.com/fuckflickr/data/git-friendly/pull.png" alt="" title="Rolling in style" />
a330dc4 @jamiew Update the docs
authored
40
4561aa8 @jamiew README copy cleanup; fix @mmalecki URL
authored
41 Example session:
a330dc4 @jamiew Update the docs
authored
42
43 pre. $ pull
44 $ branch awesomeness
45 $ echo "BUMP" >> README
46 $ git commit -a -m "Righteous bump"
f005972 @jamiew Update README with the latest & greatest, including passing a target …
authored
47 $ branch master
a330dc4 @jamiew Update the docs
authored
48 $ merge awesomeness
49 $ push
1085c8b @jamiew Enhanced config pimping in the README
authored
50
51
447e480 @jamiew READYOU improvements. This stuff is important.
authored
52
53 h2. Commands
54
4561aa8 @jamiew README copy cleanup; fix @mmalecki URL
authored
55 | *pull* | Stash any local changes, pull from remote using rebase, updates submodules, pop your stash, then run `bundle install` and/or `npm install` if necessary |
f005972 @jamiew Update README with the latest & greatest, including passing a target …
authored
56 | *push* | Push your changes to the remote + copy a sexy diff URL like "http://github.com/jamiew/git-friendly/compare/e96033...5daed4":http://github.com/jamiew/git-friendly/compare/e96033...5daed4 to your clipboard (works on Mac and Linux) |
4561aa8 @jamiew README copy cleanup; fix @mmalecki URL
authored
57 | *branch&nbsp;[name]* | Switch branches or create new local branch if it doesn't exist. Intelligently sets up remote branch tracking so you can just type 'git pull' and not always 'git pull origin newbranch'. If no argument specified will list all local and remote branches. |
f005972 @jamiew Update README with the latest & greatest, including passing a target …
authored
58 | *merge&nbsp;[name]* | Merge the specified branch into the current branch. Rebases first if the branch is local-only |
447e480 @jamiew READYOU improvements. This stuff is important.
authored
59
a330dc4 @jamiew Update the docs
authored
60 h2. Bonus: Pimp Your Configs
61
4561aa8 @jamiew README copy cleanup; fix @mmalecki URL
authored
62 I strongly recommend editing your global ~/.gitconfig and adding chill features like ANSI color, command aliases (e.g. "git st" instead of "git status"), automatic remote tracking and more. Check out "my ~/.gitconfig":https://gist.github.com/668161 to get started.
447e480 @jamiew READYOU improvements. This stuff is important.
authored
63
4561aa8 @jamiew README copy cleanup; fix @mmalecki URL
authored
64 I also recommend adding the current git branch to your Terminal prompt (PS1) or you'll quickly lose your place -- here is my "pimp_prompt() bash function":https://gist.github.com/790086 which goes in your @~/.bash_profile@ or @~/.bashrc@, then type @source ~/.bashrc@ to reload.
447e480 @jamiew READYOU improvements. This stuff is important.
authored
65
3cec542 @jamiew Fix images
authored
66 <img src="http://jamiedubs.com/fuckflickr/data/git-friendly/pimped-prompt.jpg" alt="" title="You could be this cool" />
907929e @jamiew More images
authored
67
447e480 @jamiew READYOU improvements. This stuff is important.
authored
68
e6659c6 @jamiew Update README: add @mmalecki to contributorsi, and clipboard copy now…
authored
69 h2. License
70
71 Code released under an MIT license.
72
0713b23 @jamiew Document our commit & credit contribution policy
authored
73 Fork away, do whatever. Pull requests welcome.
74
75 Following the practices of "Rubinius":http://www.programblings.com/2008/04/15/rubinius-for-the-layman-part-2-how-rubinius-is-friendly/, anyone who submits an accepted patch is granted a commit bit (write access to the repository).
76
77 Following the practices of "FAT Lab":http://fffff.at, anyone who submits an accepted patch is granted credit and attribution bits.
e96033c @jamiew It's a READYOU
authored
78
4561aa8 @jamiew README copy cleanup; fix @mmalecki URL
authored
79
80 h2. Contributors
81
82 * "Jamie Wilkinson":http://jamiedubs.com ("@jamiew":http://github.com/jamiew)
83 * "Ethan Bruning":https://github.com/ebruning ("@ebruning":https://github.com/ebruning)
84 * "John Manoogian III":http://jm3.net ("@jm3":http://github.com/jm3)
d600c45 @jamiew Add @cj's full name
authored
85 * "CJ Lazell":http://cj.io/ ("@cj":http://github.com/cj)
4561aa8 @jamiew README copy cleanup; fix @mmalecki URL
authored
86 * "Maciej Małecki":http://twitter.com/mmalecki ("@mmalecki":https://github.com/mmalecki)
87 * "Ezekiel Templin":http://blog.ezkl.org/ ("@ezkl":https://github.com/ezkl)
5db3a06 @sapegin Link to English version of my site instead of Russian.
sapegin authored
88 * "Artem Sapegin":http://sapegin.me/ ("@sapegin":https://github.com/sapegin)
6567846 @jamiew Add @hdennison to contributors list
authored
89 * "Harold Dennison":http://hdennison.com/ ("@hdennison":https://github.com/hdennison)
1698d31 @jamiew Add @sleepyboy to Contributors list
authored
90 * "Andriy Prokopenko":http://andriyprokopenko.com/ ("@sleepyboy":https://github.com/sleepyboy)
4561aa8 @jamiew README copy cleanup; fix @mmalecki URL
authored
91
Something went wrong with that request. Please try again.