Customization/powerlevel10k
1
0
Fork 0
mirror of https://github.com/romkatv/powerlevel10k.git synced 2024-11-11 00:00:06 +00:00
Code Releases Activity

adding README file for Github

Browse source
This commit is contained in:
Ben Hilburn 2015-02-01 15:33:32 -08:00
parent acb2afdf40
commit 27feb6fec7
1 changed files with 76 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

76
README.md Normal file
View file

@ -0,0 +1,76 @@
## powerlevel9k Theme for Oh-My-Zsh
This is a theme for [Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh). This
theme uses [Powerline Fonts](https://github.com/Lokaltog/powerline-fonts), thus
giving you the most bad-ass terminal styling in the universe (as of 2015 C.E.).
Look like an 1337 hacker. Use powerlevel9k.
In addition to looking amazing, this theme actually provides a lot of useful
information.
### Features
* Shows lots of information about Git repositories, including:
* branch / tag name
* current action status (rebasing, merging, etc.,)
* being behind / ahead of your remote
* various local working tree statuses
* Shows command number in right-prompt (so you can `$ !<num>` to re-run)
* Shows return-code of command if it is an error code
* Shows system time in right-prompt
* Indicates background jobs with a gear
* Will conditionally display the `user@host` string
**If you would like an OMZ theme that provides most of the same features but
doesn't require Powerline fonts, check out the sister font,
[hackersaurus](https://github.com/bhilburn/hackersaurus).**
These screenshots should give you an idea of what `powerlevel9k` looks like:
![](http://bhilburn.org/content/images/2014/12/powerlevel9k.png)
![](http://bhilburn.org/content/images/2015/01/pl9k-improved.png)
### Installation
First, you need to install Powerline Fonts. You can find the installation
instructions
here](https://powerline.readthedocs.org/en/latest/installation/linux.html#fonts-installation).
You can also find the raw font files [in this Github
repository](https://github.com/powerline/fonts).
To install this theme, drop the `.zsh-theme` file into your `.oh-my-zsh/themes`
directory. A better form of installation is to clone this repository and then
create a symlink in your 'themes' directory:
$ git clone https://github.com/bhilburn/hackersaurus.git
$ ln -s hackersaurus.git/hackersaurus.zsh-theme ~/.oh-my-zsh/themes/hackersaurus.zsh-theme
Note that *you cannot clone this repository into your `~/.oh-my-zsh/themes/` directory*.
Oh-My-Zsh does not traverse subdirectories for themes, and will not find your theme.
You then need to select it in your `~/.zshrc`:
ZSH_THEME="hackersaurus"
If you do not want to display the `user@host` string, you should also put this
in your `~/.zshrc`:
export DEFAULT_USER=<your username>
### History
This theme was first announced [on my
blog](http://bhilburn.org/powerlevel9k-oh-my-zsh-theme/) in December of 2014. At
the time, the theme was missing some of the more advanced Git information. [Tom
Upton](http://www.thomasupton.com/) then helped me get things fixed up with [his
`vcs_info` hooks](https://github.com/tupton/dotfiles/blob/master/zsh/zshrc).
### Bugs / Contact
If you have any requests or bug reports, please use the tracker in this Github
repository.