jimeh/git-aware-prompt
1
0
Fork 0
mirror of https://github.com/jimeh/git-aware-prompt.git synced 2026-02-19 13:36:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Wrap long lines in readme

Browse Source
This commit is contained in:
Jim Myhrberg
2013-04-25 23:31:11 +01:00
parent a83ef266fe
commit 02fb756434
1 changed files with 20 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -1,15 +1,21 @@
# Git Aware Prompt
Working with Git and its great branching/merging features is amazing. Constantly switching branches can be confusing though as you have to run `git status` to see which branch you're currently on.
Working with Git and its great branching/merging features is
amazing. Constantly switching branches can be confusing though as you have to
run `git status` to see which branch you're currently on.
The solution to this is to have your terminal prompt display the current branch. There's a [number][1] [of][2] [articles][3] [available][4] online about how to achieve this.
The solution to this is to have your terminal prompt display the current
branch. There's a [number][1] [of][2] [articles][3] [available][4] online
about how to achieve this.
I based this project mainly on Aaron Crane's [solution][1].
## Overview
If you `cd` to a Git working directory, you will see the current Git branch name displayed in your terminal prompt. When you're not in a Git working directory, your prompt works like normal.
If you `cd` to a Git working directory, you will see the current Git branch
name displayed in your terminal prompt. When you're not in a Git working
directory, your prompt works like normal.
![Git Branch in Prompt](https://raw.github.com/jimeh/git-aware-prompt/master/preview.png)
@@ -28,21 +34,28 @@ Edit your `~/.profile` or `~/.bash_profile` and add the following to the top:
source $GITAWAREPROMPT/main.sh
export PS1="\u@\h \w \[$txtcyn\]\$git_branch\[$txtred\]\$git_dirty\[$txtrst\]\$ "
Optionally, if you want a nice pretty prompt when using `sudo -s`, also add this line:
Optionally, if you want a nice pretty prompt when using `sudo -s`, also add
this line:
export SUDO_PS1="\[$bakred\]\u@\h\[$txtrst\] \w\$ "
## Configuring
If you followed the above installation instructions, you've added the default prompt style already by defining the `PS1` variable. If you don't know how to customize your prompt, I recommend you check [this][5] how-to.
If you followed the above installation instructions, you've added the default
prompt style already by defining the `PS1` variable. If you don't know how to
customize your prompt, I recommend you check [this][5] how-to.
Basically, to have the current Git branch shown, simply add `$git_branch` to your `PS1` variable, and make sure the variable value is defined with double quotes. A set of color variables have also been set for you to use. For a list of available colors check `colors.sh`.
Basically, to have the current Git branch shown, simply add `$git_branch` to
your `PS1` variable, and make sure the variable value is defined with double
quotes. A set of color variables have also been set for you to use. For a list
of available colors check `colors.sh`.
## License
(MIT-like license, without the requirement to keep copyright notice in reproductions)
(MIT-like license, without the requirement to keep copyright notice in
reproductions)
Copyright (c) 2009 Jim Myhrberg