This commit is contained in:
Chris Wanstrath 2009-12-08 17:40:45 -08:00
Родитель b7abecfa89
Коммит 5010d55f9f
1 изменённых файлов: 31 добавлений и 8 удалений

Просмотреть файл

@ -31,10 +31,16 @@ Aliased:
Install
-------
### Standalone
`hub` can be installed most easily as a stand alone script:
curl http://defunkt.github.com/hub/standalone > ~/bin/hub && chmod 0755 !$
If ~/bin/hub is in your path, you're ready to roll!
### Rubygem
It also can be installed using Rubygems:
$ gem install hub -s http://gemcutter.org/
@ -44,16 +50,17 @@ standalone script, to avoid the Rubygems startup tax:
$ hub install standalone
### Source
You can also install from source:
$ git clone git://github.com/defunkt/hub.git
$ cd hub
$ rake install_standalone
Once you've installed `hub`, you can invoke it directly from the
command line:
$ hub version
Aliasing
--------
To get the full experience, alias your `git` command to run `hub` by
placing the following in your `.bash_profile` (or relevant startup
@ -62,16 +69,15 @@ script):
alias git=hub
Typing `hub alias <shell>` will display alias instructions for you
shell.
Note that if you're running `hub` under Rubygems, it may be
slow. Installing the standalone script is the fastest (and
recommended) method.
shell. `hub alias` alone will show the known shells.
Commands
--------
Assuming you've aliased `hub` to `git` these commands now have
superpowers:
### git clone
$ git clone schacon/ticgit
@ -100,6 +106,23 @@ Commands
> (improved git help)
GitHub Login
------------
To get the most out of `hub`, you'll want to ensure your GitHub login
is stored locally in your Git config.
To test it run this:
$ git config --global github.user
If you see nothing, you need to set the config setting:
$ git config --global github.user YOUR_USERNAME
See <http://github.com/guides/local-github-config> for more information.
Prior Art
---------