Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added syntax highlighting for code blocks. Few minor typographical tw…

…eaks.
  • Loading branch information...
commit b063d38472ff77faa65c3326a663621c25b49765 1 parent a59681d
Tony authored
Showing with 20 additions and 4 deletions.
  1. +20 −4 README.markdown
View
24 README.markdown
@@ -24,46 +24,58 @@ Installation
Install the most recent available version under `/usr/local`:
+```bash
$ git clone git://github.com/rtomayko/git-sh.git
$ cd git-sh
$ make
$ sudo make install
+```
Start a shell with `git-sh`:
+```bash
$ git-sh
master!git-sh> help
+```
Use the `PREFIX` environment variable to specify a different install location.
For example, under `~/bin`:
+```bash
$ make install PREFIX=~
+```
Basic Usage
-----------
Typical usage is to change into a git working copy and then start the shell:
+```bash
$ cd mygreatrepo
$ git sh
master!mygreatrepo> help
+```
Core git commands and git command aliases defined in `~/.gitconfig` can be
used as top-level commands:
+```bash
master!mygreatrepo> checkout -b new
new!mygreatrepo> log -p
new!mygreatrepo> rebase -i HEAD~10
+```
It's really just a normal bash shell, though, so all commands on `PATH` and any
aliases defined in `~/.bashrc` are also available:
+```bash
new!mygreatrepo> ls -l
new!mygreatrepo> vim somefile
+```
-*IMPORTANT: `rm`, `mv`, and `diff` are aliased to their git counterparts. Use
-`command(1)` (e.g., `command rm`) or qualify the command (e.g. `/bin/rm`)
-to use system versions.*
+
+*IMPORTANT: `rm`, `mv`, and `diff` are aliased to their git counterparts. To use system versions,
+run `command(1)` (e.g., `command rm`) or qualify the command (e.g. `/bin/rm`).*
Prompt
------
@@ -73,18 +85,22 @@ path to the current working directory from the root of the work tree. If the
work tree includes modified files that have not yet been staged, a dirty status
indicator (`*`) is also displayed.
-The git-sh prompt includes ANSI colors when the git `color.ui` option is set and
+The git-sh prompt includes ANSI colors when the git `color.ui` option is
enabled. To enable git-sh's prompt colors explicitly, set the `color.sh` config
value to `auto`:
+```bash
$ git config --global color.sh auto
+```
Customize prompt colors by setting the `color.sh.branch`, `color.sh.workdir`,
and `color.sh.dirty` git config values:
+```bash
$ git config --global color.sh.branch 'yellow reverse'
$ git config --global color.sh.workdir 'blue bold'
$ git config --global color.sh.dirty 'red'
+```
See [colors in git](http://scie.nti.st/2007/5/2/colors-in-git) for information.
Please sign in to comment.
Something went wrong with that request. Please try again.