omg/README.md
2013-11-13 10:09:39 +01:00

90 lines
3.5 KiB
Markdown

oh-my-git!
=========
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/01-not in a git repo.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/02-in a git repo.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/03-on master.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/04-untracked-add-commit.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/05-rm.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/06-a typical session.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/07-tracking branch.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/08-explicit upstream.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/09-ahead.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/10-behind.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/11-diverge.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/12-detached.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/samples/13-stash.jpg)
![alt tag](https://raw.github.com/arialdomartini/oh-my-git-gh-pages/gh-pages/images/shut-up.gif)
Installation for Bash
---------------------
One liner for Mac:
cd ~ && git clone https://github.com/arialdomartini/oh-my-git.git && echo source $HOME/oh-my-git/prompt.sh >> .profile
One liner for Ubuntu:
cd ~ && git clone https://github.com/arialdomartini/oh-my-git.git && echo source $HOME/oh-my-git/prompt.sh >> .bashrc
Then, set your Terminal font to Monospace (or edit oh-my-git and change the symbols used)
Manual installation for Bash
----------------------------
Fork the repo and git clone it in your home directory
Then add
source $HOME/oh-my-git/prompt.sh
to the bash startup file (`~/.profile` on Mac, `~/.bashrc` on Linux)
zsh installation
----------------
Install `antigen`
cd ~ && git clone https://github.com/zsh-users/antigen.git .antigen
Edit your `.zshrc` file including
source "$HOME/.antigen/antigen.zsh"
antigen-bundle arialdomartini/oh-my-git-tmp
antigen theme arialdomartini/oh-my-git-themes arialdo-granzestyle
antigen-apply
`oh-my-git-themes` includes two themes: `arialdo-granzestyle` which is inspired to the great @granze theme, and `arialdo-pathinline`
I also suggest to include
antigen-use oh-my-zsh
antigen-bundle git
antigen-bundle zsh-users/zsh-syntax-highlighting
antigen-bundle zsh-users/zsh-history-substring-search
but they are optional.
Then, restart zsh. `antigen` will download and install all that's needed.
Known bugs and limitations
--------------------------
* It works weird on brand new repositories, before the first commit
* It has been tested on Mac and Ubuntu only. I never managed to make it work on Cygwin
* You need an unicode font (like Menlo or Monaco on Mac OS X, or Monospace on Ubuntu)
* With the default Ubuntu terminal font, some symbols are not properly displayed. Use Monospace, or edit the `prompt.sh` file and choose other symbols
zsh version
-----------
Coming soon. I'm working on the integration with `zsh` + `oh-my-zsh` + `antigen`
Wanna help? Great! Fork it! It will be really appreciated!