From 2ad6280b517d48d0baf399fe460e5ab30d81fda1 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Tue, 26 May 2015 21:53:29 +0200 Subject: Added documentation. --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 2c3f2a2d..e4843f76 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,7 @@ currently available are: * **context** - Your username and host (more info below) * **dir** - Your current working directory. * **history** - The command number for the current line. +* **node_version** - Show the version number of the installed node. * **rbenv** - Ruby environment information (if one is active). * **rspec_stats** - Show a ratio of test classes vs code classes for RSpec. * **status** - The return code of the previous command, and status of background jobs. -- cgit v1.2.3 From 79678020f7a3abff84f531345234f35f1826e6e4 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Tue, 26 May 2015 21:55:07 +0200 Subject: Better documentation. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index e4843f76..7678d353 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ currently available are: * **context** - Your username and host (more info below) * **dir** - Your current working directory. * **history** - The command number for the current line. -* **node_version** - Show the version number of the installed node. +* **node_version** - Show the version number of the installed Node.js. * **rbenv** - Ruby environment information (if one is active). * **rspec_stats** - Show a ratio of test classes vs code classes for RSpec. * **status** - The return code of the previous command, and status of background jobs. -- cgit v1.2.3 From 77024543f2fd6afd013a2fc340c9315ad360eeb5 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Thu, 28 May 2015 00:36:40 +0200 Subject: Added documentation. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2c3f2a2d..d2f7be39 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,9 @@ emulator the Powerline font you want to use. #### Install Powerlevel9k -To install this theme, clone this repository into your Oh-My-Zsh `custom/themes` +##### Within Oh-my-ZSH + +To install this theme, clone this repository into your [Oh-my-Zsh](https://github.com/robbyrussell/oh-my-zsh) `custom/themes` directory. $ cd ~/.oh-my-zsh/custom @@ -66,6 +68,19 @@ You then need to select this theme in your `~/.zshrc`: ZSH_THEME="powerlevel9k/powerlevel9k" +##### With Prezto + +To install this theme, clone this repository into your [Prezto](https://github.com/sorin-ionescu/prezto) `prompt/external` +directory. + + $ cd ~.zprezto/modules/prompt/external + $ git clone https://github.com/bhilburn/powerlevel9k.git + $ ln -s powerlevel9k/powerlevel9k.zsh-theme ../functions/prompt_powerlevel9k_setup + +You then need to select this theme in your `~/.zpreztorc`: + + zstyle ':prezto:module:prompt' theme 'powerlevel9k' + ### Segment Customization Customizing your prompt is easy! Select the segments you want to have displayed, -- cgit v1.2.3 From 19e0689b0232a71198e753e17bf334da632df7c6 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Thu, 4 Jun 2015 01:41:04 +0200 Subject: Improved documentation. --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2c3f2a2d..0d8adb49 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [powerlevel9k Theme for Oh-My-Zsh](#powerlevel9k-theme-for-oh-my-zsh) + - [Features](#features) + - [Installation](#installation) + - [Install Powerline Fonts](#install-powerline-fonts) + - [Install Powerlevel9k](#install-powerlevel9k) + - [Segment Customization](#segment-customization) + - [The AWS Profile Segment](#the-aws-profile-segment) + - [The 'context' Segment](#the-context-segment) + - [Test ratio](#test-ratio) + - [The 'time' segment](#the-time-segment) + - [The 'vcs' Segment](#the-vcs-segment) + - [Symbols](#symbols) + - [Styling](#styling) + - [Fonts](#fonts) + - [Double-Lined Prompt](#double-lined-prompt) + - [Light Color Theme](#light-color-theme) + - [Troubleshooting](#troubleshooting) + - [Gaps Between Segments](#gaps-between-segments) + - [Contributions / Bugs / Contact](#contributions--bugs--contact) + + + ## powerlevel9k Theme for Oh-My-Zsh This is a theme for [Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh). This @@ -40,8 +66,9 @@ Here are some screenshots of `powerlevel9k` with default settings: ### Installation -There are two things you need to make this theme work correctly: Powerline -fonts, and the theme itself. +You just need to install the theme and set `POWERLEVEL9K_MODE='compatible'` +to join the experience. If you want to customize your experience even further +read the chapter about "[fonts](#fonts)" or about "[segment customization](#segment-customization)". #### Install Powerline Fonts First, you need to install Powerline Fonts. You can find the [installation @@ -158,6 +185,25 @@ The `vcs` segment uses various symbols to tell you the state of your repository: You can configure the look and feel of your prompt easily with some built-in options. +#### Fonts + +If you set `POWERLEVEL9K_MODE='compatible'` you just get a little glimpse of +the beauty of this theme. + +To get nicer Icons you need to install a [powerline-patched](https://github.com/Lokaltog/powerline-fonts) font. +In your Terminal you need to select this font and in your `~/.zshrc` you need +to set `POWERLEVEL9K_MODE='powerline-patched'`. +Screenshot: +![](http://bhilburn.org/content/images/2015/01/pl9k-improved.png) + +If even these Icons did not impress you, have a look at `POWERLEVEL9K_MODE='awesome-patched'`. +For this mode, you have to install a [awesome-patched](https://github.com/gabrielelana/awesome-terminal-fonts/tree/patching-strategy/patched) font and set the according mode. +Screenshot: +![](https://cloud.githubusercontent.com/assets/1544760/7959660/67612918-09fb-11e5-9ef2-2308363c3c51.png) + +If you prefer segements as rectangles, just set `POWERLEVEL9K_MODE='flat'`, but +beware: You still need a [awesome-patched](https://github.com/gabrielelana/awesome-terminal-fonts/tree/patching-strategy/patched) font. + #### Double-Lined Prompt By default, `powerlevel9k` is a single-lined prompt. If you would like to have -- cgit v1.2.3 From 5fafa2005c53d34e4776289cbc29447c3b6cfcd6 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Thu, 4 Jun 2015 01:43:00 +0200 Subject: Introduction should be in first place. --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0d8adb49..c754e538 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ +## 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 epic terminal styling in the universe. + +Look like a bad-ass. Impress everyone in 'Screenshot Your Desktop' threads. Use powerlevel9k. + +In addition to looking amazing, this theme actually provides a lot of useful +information in configurable prompt segments. + **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* @@ -24,17 +35,6 @@ -## 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 epic terminal styling in the universe. - -Look like a bad-ass. Impress everyone in 'Screenshot Your Desktop' threads. Use powerlevel9k. - -In addition to looking amazing, this theme actually provides a lot of useful -information in configurable prompt segments. - ### Features * Supports `git` and `mercurial` repo information through ZSH's `VCS_INFO`: -- cgit v1.2.3 From 301d79c6faf88439c64181d36d4dfe4d343c0c88 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Thu, 4 Jun 2015 01:49:01 +0200 Subject: Powerline-Font is now optional. --- README.md | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c754e538..684dcc36 100644 --- a/README.md +++ b/README.md @@ -70,17 +70,6 @@ You just need to install the theme and set `POWERLEVEL9K_MODE='compatible'` to join the experience. If you want to customize your experience even further read the chapter about "[fonts](#fonts)" or about "[segment customization](#segment-customization)". -#### Install Powerline Fonts -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) if you want to manually install -them for your OS. - -After you have installed Powerline fonts, make the default font in your terminal -emulator the Powerline font you want to use. - #### Install Powerlevel9k To install this theme, clone this repository into your Oh-My-Zsh `custom/themes` @@ -191,8 +180,10 @@ If you set `POWERLEVEL9K_MODE='compatible'` you just get a little glimpse of the beauty of this theme. To get nicer Icons you need to install a [powerline-patched](https://github.com/Lokaltog/powerline-fonts) font. -In your Terminal you need to select this font and in your `~/.zshrc` you need +In your terminal emulator you need to select this font and in your `~/.zshrc` you need to set `POWERLEVEL9K_MODE='powerline-patched'`. +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) if you want to manually install them for your OS. Screenshot: ![](http://bhilburn.org/content/images/2015/01/pl9k-improved.png) -- cgit v1.2.3 From 3dc5084e40b2e10272d072c7d6f05b642016e326 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Thu, 4 Jun 2015 03:58:27 +0200 Subject: Added a little "Developers Guide" --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++ powerlevel9k.zsh-theme | 19 +++++++++++++----- 2 files changed, 66 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index dc8798fe..76b98ea7 100644 --- a/README.md +++ b/README.md @@ -256,3 +256,55 @@ Please submit your contribution as a Github pull-request. If you would like to contact me directly, you can find my e-mail address on my [Github profile page](https://github.com/bhilburn). +#### Developers Guide + +The theme has grown a lot lately, so I think a little explanation would be +helpful. + +##### Basic Knowledge + +Our main entry point are the `PROMPT` and `RPROMPT` variables, which are +interpreted by zsh itself. All that this (and any other) theme does is +filling these two variables with control instructions (like defining +colors, etc.) and ready-to-use data. So within this theme we collect a +whole bunch of information to put in that variables. You can find +`PROMPT` and `RPROMPT` at the very end of the `powerlevel9k.zsh-theme`. + +This simple diagram may explain the invoking order better: + +``` ++-----+ +---------+ +| Zsh |--->| $PROMPT | ++-----+ +---------+ + | + V + +---------------------+ +------------+ +---------------------+ + | build_left_prompt() |--->| prompt_*() |->| $1_prompt_segment() | + +---------------------+ +------------+ +---------------------+ +``` + +##### Adding Segments + +Feel free to add your own segments. Every segment gets called with an +orientation as first parameter (`left` or `right`), so we can figure +out on which side we should draw the segment. This information is +used at the time we call the actual segment-drawing function: +`$1_prompt_segment`. To make the magic color-overwrite mechanism to +work, we have to pass our function name as first argument. Usually +this is just `$0`. Second parameter is a default background color, +third the default foreground color. And finally we pass our content +to the function. So our function could look somewhat like this: + +```zsh + prompt_echo() { + local content='Hello World!' + $1_prompt_segment $0 blue red $content + } +``` + +At this point we can overwrite our blue-on-red segment by putting + + POWERLEVEL9K_ECHO_FOREGROUND="200" + POWERLEVEL9K_ECHO_BACKGROUND="040" + +in our `~/.zshrc`. We now have a pink-on-green segment. Yay! diff --git a/powerlevel9k.zsh-theme b/powerlevel9k.zsh-theme index f65143a1..726ccbb9 100644 --- a/powerlevel9k.zsh-theme +++ b/powerlevel9k.zsh-theme @@ -135,8 +135,13 @@ fi ################################################################ # Begin a left prompt segment -# Takes two arguments, background and foreground. Both can be omitted, -# rendering default background/foreground. +# Takes four arguments: +# * $1: Name of the function that was orginally invoked (mandatory). +# Necessary, to make the dynamic color-overwrite mechanism work. +# * $2: Background color +# * $3: Foreground color +# * $4: The segment content +# The latter three can be omitted, left_prompt_segment() { # Overwrite given background-color by user defined variable for this segment. # We get as first Parameter the function name, which called this function. @@ -177,9 +182,13 @@ left_prompt_end() { } # Begin a right prompt segment -# Takes two arguments, background and foreground. Both can be omitted, -# rendering default background/foreground. No ending for the right prompt -# segment is needed (unlike the left prompt, above). +# Takes four arguments: +# * $1: Name of the function that was orginally invoked (mandatory). +# Necessary, to make the dynamic color-overwrite mechanism work. +# * $2: Background color +# * $3: Foreground color +# * $4: The segment content +# No ending for the right prompt segment is needed (unlike the left prompt, above). right_prompt_segment() { # Overwrite given background-color by user defined variable for this segment. local BACKGROUND_USER_VARIABLE=POWERLEVEL9K_${(U)1#prompt_}_BACKGROUND -- cgit v1.2.3 From 2c370532f9befa5cfa51723e91dd59d173a73ca4 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Thu, 4 Jun 2015 04:59:16 +0200 Subject: Icon-Explanation as table. --- README.md | 60 +++++++++++++++++++++++++++++++----------------------------- 1 file changed, 31 insertions(+), 29 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7a5fdaf5..be364277 100644 --- a/README.md +++ b/README.md @@ -13,25 +13,23 @@ information in configurable prompt segments. **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* -- [powerlevel9k Theme for Oh-My-Zsh](#powerlevel9k-theme-for-oh-my-zsh) - - [Features](#features) - - [Installation](#installation) - - [Install Powerline Fonts](#install-powerline-fonts) - - [Install Powerlevel9k](#install-powerlevel9k) - - [Segment Customization](#segment-customization) - - [The AWS Profile Segment](#the-aws-profile-segment) - - [The 'context' Segment](#the-context-segment) - - [Test ratio](#test-ratio) - - [The 'time' segment](#the-time-segment) - - [The 'vcs' Segment](#the-vcs-segment) - - [Symbols](#symbols) - - [Styling](#styling) - - [Fonts](#fonts) - - [Double-Lined Prompt](#double-lined-prompt) - - [Light Color Theme](#light-color-theme) - - [Troubleshooting](#troubleshooting) - - [Gaps Between Segments](#gaps-between-segments) - - [Contributions / Bugs / Contact](#contributions--bugs--contact) +- [Features](#features) +- [Installation](#installation) + - [Install Powerlevel9k](#install-powerlevel9k) +- [Segment Customization](#segment-customization) + - [The AWS Profile Segment](#the-aws-profile-segment) + - [The 'context' Segment](#the-context-segment) + - [Test ratio](#test-ratio) + - [The 'time' segment](#the-time-segment) + - [The 'vcs' Segment](#the-vcs-segment) + - [Symbols](#symbols) +- [Styling](#styling) + - [Fonts](#fonts) + - [Double-Lined Prompt](#double-lined-prompt) + - [Light Color Theme](#light-color-theme) +- [Troubleshooting](#troubleshooting) + - [Gaps Between Segments](#gaps-between-segments) +- [Contributions / Bugs / Contact](#contributions--bugs--contact) @@ -159,16 +157,20 @@ Example: ##### Symbols -The `vcs` segment uses various symbols to tell you the state of your repository: - -* `↑4` - The number of commits your repository is ahead of your remote branch -* `↓5` - The number of commits your repository is behind of your remote branch -* `⍟3` - The number of stashes, here 3. -* `●` - There are unstaged changes in your working copy -* `✚` - There are staged changes in your working copy -* `?` - There are files in your working copy, that are unknown to your repository -* `→` - The name of your branch differs from its tracking branch. -* `☿` - A mercurial bookmark is active. +The `vcs` segment uses various symbols to tell you the state of your repository. +These symbols depend on your installed [Font](#fonts) and your `POWERLEVEL9K_MODE` +set. + +| `powerline-patched` | `awesome-patched` | explanation +|---------------------|-------------------|--------------------------------------------- +| `↑4` | | Number of commits your repository is ahead of your remote branch +| `↓5` | | Number of commits your repository is behind of your remote branch +| `⍟3` | | Number of stashes, here 3. +| `●` | | There are unstaged changes in your working copy +| `✚` | | There are staged changes in your working copy +| `?` | | There are files in your working copy, that are unknown to your repository +| `→` | | The name of your branch differs from its tracking branch. +| `☿` | | A mercurial bookmark is active. ### Styling -- cgit v1.2.3 From 3d1a65bfffaf38b800bcdc9c59614bfb579831ee Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Thu, 4 Jun 2015 05:14:33 +0200 Subject: Added Icons for awesome-patched-Description. --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index be364277..22567a41 100644 --- a/README.md +++ b/README.md @@ -163,14 +163,18 @@ set. | `powerline-patched` | `awesome-patched` | explanation |---------------------|-------------------|--------------------------------------------- -| `↑4` | | Number of commits your repository is ahead of your remote branch -| `↓5` | | Number of commits your repository is behind of your remote branch -| `⍟3` | | Number of stashes, here 3. -| `●` | | There are unstaged changes in your working copy -| `✚` | | There are staged changes in your working copy -| `?` | | There are files in your working copy, that are unknown to your repository -| `→` | | The name of your branch differs from its tracking branch. -| `☿` | | A mercurial bookmark is active. +| `↑4` | ![icon_outgoing](https://cloud.githubusercontent.com/assets/1544760/7976089/b5904d6e-0a76-11e5-8147-5e873ac52d79.gif)4 | Number of commits your repository is ahead of your remote branch +| `↓5` | ![icon_incoming](https://cloud.githubusercontent.com/assets/1544760/7976091/b5909c9c-0a76-11e5-9cad-9bf0a28a897c.gif)5 | Number of commits your repository is behind of your remote branch +| `⍟3` | ![icon_stash](https://cloud.githubusercontent.com/assets/1544760/7976094/b5ae9346-0a76-11e5-8cc7-e98b81824118.gif)3 | Number of stashes, here 3. +| `●` | ![icon_unstaged](https://cloud.githubusercontent.com/assets/1544760/7976096/b5aefa98-0a76-11e5-9408-985440471215.gif) | There are unstaged changes in your working copy +| `✚` | ![icon_staged](https://cloud.githubusercontent.com/assets/1544760/7976095/b5aecc8a-0a76-11e5-8988-221afc6e8982.gif) | There are staged changes in your working copy +| `?` | ![icon_untracked](https://cloud.githubusercontent.com/assets/1544760/7976098/b5c7a2e6-0a76-11e5-8c5b-315b595b2bc4.gif) | There are files in your working copy, that are unknown to your repository +| `→` | ![icon_remote_tracking_branch](https://cloud.githubusercontent.com/assets/1544760/7976093/b5ad2c0e-0a76-11e5-9cd3-62a077b1b0c7.gif) | The name of your branch differs from its tracking branch. +| `☿` | ![icon_bookmark](https://cloud.githubusercontent.com/assets/1544760/7976197/546cfac6-0a78-11e5-88a6-ce3a1e0a174e.gif) | A mercurial bookmark is active. +| `` | ![](https://cloud.githubusercontent.com/assets/1544760/7976087/b58bbe3e-0a76-11e5-8d0d-7a5c1bc7f730.gif) | Branch Icon +| None | ![icon_commit](https://cloud.githubusercontent.com/assets/1544760/7976088/b58f4e50-0a76-11e5-9e70-86450d937030.gif)2c3705 | The current commit hash. Here "2c3705" +| None | ![icon_git](https://cloud.githubusercontent.com/assets/1544760/7976092/b5909f80-0a76-11e5-9950-1438b9d72465.gif) | Repository is a git repository +| None | ![icon_mercurial](https://cloud.githubusercontent.com/assets/1544760/7976090/b5908da6-0a76-11e5-8c91-452b6e73f631.gif) | Repository is a Mercurial repository ### Styling -- cgit v1.2.3 From d7f53e8b36ff5666c6a869874a9830373f3bc445 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Fri, 5 Jun 2015 08:51:31 +0200 Subject: Branch-Icon as Image --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 22567a41..f8efe498 100644 --- a/README.md +++ b/README.md @@ -171,7 +171,8 @@ set. | `?` | ![icon_untracked](https://cloud.githubusercontent.com/assets/1544760/7976098/b5c7a2e6-0a76-11e5-8c5b-315b595b2bc4.gif) | There are files in your working copy, that are unknown to your repository | `→` | ![icon_remote_tracking_branch](https://cloud.githubusercontent.com/assets/1544760/7976093/b5ad2c0e-0a76-11e5-9cd3-62a077b1b0c7.gif) | The name of your branch differs from its tracking branch. | `☿` | ![icon_bookmark](https://cloud.githubusercontent.com/assets/1544760/7976197/546cfac6-0a78-11e5-88a6-ce3a1e0a174e.gif) | A mercurial bookmark is active. -| `` | ![](https://cloud.githubusercontent.com/assets/1544760/7976087/b58bbe3e-0a76-11e5-8d0d-7a5c1bc7f730.gif) | Branch Icon +| ![icon_branch_powerline](https://cloud.githubusercontent.com/assets/1544760/8000852/e7e8d8a0-0b5f-11e5-9834-de9b25c92284.gif) + | ![](https://cloud.githubusercontent.com/assets/1544760/7976087/b58bbe3e-0a76-11e5-8d0d-7a5c1bc7f730.gif) | Branch Icon | None | ![icon_commit](https://cloud.githubusercontent.com/assets/1544760/7976088/b58f4e50-0a76-11e5-9e70-86450d937030.gif)2c3705 | The current commit hash. Here "2c3705" | None | ![icon_git](https://cloud.githubusercontent.com/assets/1544760/7976092/b5909f80-0a76-11e5-9950-1438b9d72465.gif) | Repository is a git repository | None | ![icon_mercurial](https://cloud.githubusercontent.com/assets/1544760/7976090/b5908da6-0a76-11e5-8c91-452b6e73f631.gif) | Repository is a Mercurial repository -- cgit v1.2.3 From 1c6050ac75217f3f300023eb8afbb5ab4e16701a Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Fri, 5 Jun 2015 08:52:20 +0200 Subject: Formatting. --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f8efe498..ed4aae53 100644 --- a/README.md +++ b/README.md @@ -171,8 +171,7 @@ set. | `?` | ![icon_untracked](https://cloud.githubusercontent.com/assets/1544760/7976098/b5c7a2e6-0a76-11e5-8c5b-315b595b2bc4.gif) | There are files in your working copy, that are unknown to your repository | `→` | ![icon_remote_tracking_branch](https://cloud.githubusercontent.com/assets/1544760/7976093/b5ad2c0e-0a76-11e5-9cd3-62a077b1b0c7.gif) | The name of your branch differs from its tracking branch. | `☿` | ![icon_bookmark](https://cloud.githubusercontent.com/assets/1544760/7976197/546cfac6-0a78-11e5-88a6-ce3a1e0a174e.gif) | A mercurial bookmark is active. -| ![icon_branch_powerline](https://cloud.githubusercontent.com/assets/1544760/8000852/e7e8d8a0-0b5f-11e5-9834-de9b25c92284.gif) - | ![](https://cloud.githubusercontent.com/assets/1544760/7976087/b58bbe3e-0a76-11e5-8d0d-7a5c1bc7f730.gif) | Branch Icon +| ![icon_branch_powerline](https://cloud.githubusercontent.com/assets/1544760/8000852/e7e8d8a0-0b5f-11e5-9834-de9b25c92284.gif) | ![](https://cloud.githubusercontent.com/assets/1544760/7976087/b58bbe3e-0a76-11e5-8d0d-7a5c1bc7f730.gif) | Branch Icon | None | ![icon_commit](https://cloud.githubusercontent.com/assets/1544760/7976088/b58f4e50-0a76-11e5-9e70-86450d937030.gif)2c3705 | The current commit hash. Here "2c3705" | None | ![icon_git](https://cloud.githubusercontent.com/assets/1544760/7976092/b5909f80-0a76-11e5-9950-1438b9d72465.gif) | Repository is a git repository | None | ![icon_mercurial](https://cloud.githubusercontent.com/assets/1544760/7976090/b5908da6-0a76-11e5-8c91-452b6e73f631.gif) | Repository is a Mercurial repository -- cgit v1.2.3 From 851877ed97af54abc62c75c7330f6ccd085cd1a1 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Fri, 5 Jun 2015 08:59:48 +0200 Subject: Added `compatible` icons --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ed4aae53..c62b7da0 100644 --- a/README.md +++ b/README.md @@ -161,20 +161,20 @@ The `vcs` segment uses various symbols to tell you the state of your repository. These symbols depend on your installed [Font](#fonts) and your `POWERLEVEL9K_MODE` set. -| `powerline-patched` | `awesome-patched` | explanation -|---------------------|-------------------|--------------------------------------------- -| `↑4` | ![icon_outgoing](https://cloud.githubusercontent.com/assets/1544760/7976089/b5904d6e-0a76-11e5-8147-5e873ac52d79.gif)4 | Number of commits your repository is ahead of your remote branch -| `↓5` | ![icon_incoming](https://cloud.githubusercontent.com/assets/1544760/7976091/b5909c9c-0a76-11e5-9cad-9bf0a28a897c.gif)5 | Number of commits your repository is behind of your remote branch -| `⍟3` | ![icon_stash](https://cloud.githubusercontent.com/assets/1544760/7976094/b5ae9346-0a76-11e5-8cc7-e98b81824118.gif)3 | Number of stashes, here 3. -| `●` | ![icon_unstaged](https://cloud.githubusercontent.com/assets/1544760/7976096/b5aefa98-0a76-11e5-9408-985440471215.gif) | There are unstaged changes in your working copy -| `✚` | ![icon_staged](https://cloud.githubusercontent.com/assets/1544760/7976095/b5aecc8a-0a76-11e5-8988-221afc6e8982.gif) | There are staged changes in your working copy -| `?` | ![icon_untracked](https://cloud.githubusercontent.com/assets/1544760/7976098/b5c7a2e6-0a76-11e5-8c5b-315b595b2bc4.gif) | There are files in your working copy, that are unknown to your repository -| `→` | ![icon_remote_tracking_branch](https://cloud.githubusercontent.com/assets/1544760/7976093/b5ad2c0e-0a76-11e5-9cd3-62a077b1b0c7.gif) | The name of your branch differs from its tracking branch. -| `☿` | ![icon_bookmark](https://cloud.githubusercontent.com/assets/1544760/7976197/546cfac6-0a78-11e5-88a6-ce3a1e0a174e.gif) | A mercurial bookmark is active. -| ![icon_branch_powerline](https://cloud.githubusercontent.com/assets/1544760/8000852/e7e8d8a0-0b5f-11e5-9834-de9b25c92284.gif) | ![](https://cloud.githubusercontent.com/assets/1544760/7976087/b58bbe3e-0a76-11e5-8d0d-7a5c1bc7f730.gif) | Branch Icon -| None | ![icon_commit](https://cloud.githubusercontent.com/assets/1544760/7976088/b58f4e50-0a76-11e5-9e70-86450d937030.gif)2c3705 | The current commit hash. Here "2c3705" -| None | ![icon_git](https://cloud.githubusercontent.com/assets/1544760/7976092/b5909f80-0a76-11e5-9950-1438b9d72465.gif) | Repository is a git repository -| None | ![icon_mercurial](https://cloud.githubusercontent.com/assets/1544760/7976090/b5908da6-0a76-11e5-8c91-452b6e73f631.gif) | Repository is a Mercurial repository +| `compatible` | `powerline-patched` | `awesome-patched` | explanation +|--------------|---------------------|-------------------|-------------------------- +| `↑4` | `↑4` | ![icon_outgoing](https://cloud.githubusercontent.com/assets/1544760/7976089/b5904d6e-0a76-11e5-8147-5e873ac52d79.gif)4 | Number of commits your repository is ahead of your remote branch +| `↓5` | `↓5` | ![icon_incoming](https://cloud.githubusercontent.com/assets/1544760/7976091/b5909c9c-0a76-11e5-9cad-9bf0a28a897c.gif)5 | Number of commits your repository is behind of your remote branch +| None | `⍟3` | ![icon_stash](https://cloud.githubusercontent.com/assets/1544760/7976094/b5ae9346-0a76-11e5-8cc7-e98b81824118.gif)3 | Number of stashes, here 3. +| `●` | `●` | ![icon_unstaged](https://cloud.githubusercontent.com/assets/1544760/7976096/b5aefa98-0a76-11e5-9408-985440471215.gif) | There are unstaged changes in your working copy +| `✚` | `✚` | ![icon_staged](https://cloud.githubusercontent.com/assets/1544760/7976095/b5aecc8a-0a76-11e5-8988-221afc6e8982.gif) | There are staged changes in your working copy +| `?` | `?` | ![icon_untracked](https://cloud.githubusercontent.com/assets/1544760/7976098/b5c7a2e6-0a76-11e5-8c5b-315b595b2bc4.gif) | There are files in your working copy, that are unknown to your repository +| `→` | `→` | ![icon_remote_tracking_branch](https://cloud.githubusercontent.com/assets/1544760/7976093/b5ad2c0e-0a76-11e5-9cd3-62a077b1b0c7.gif) | The name of your branch differs from its tracking branch. +| None | `☿` | ![icon_bookmark](https://cloud.githubusercontent.com/assets/1544760/7976197/546cfac6-0a78-11e5-88a6-ce3a1e0a174e.gif) | A mercurial bookmark is active. +| `@` | ![icon_branch_powerline](https://cloud.githubusercontent.com/assets/1544760/8000852/e7e8d8a0-0b5f-11e5-9834-de9b25c92284.gif) | ![](https://cloud.githubusercontent.com/assets/1544760/7976087/b58bbe3e-0a76-11e5-8d0d-7a5c1bc7f730.gif) | Branch Icon +| None | None | ![icon_commit](https://cloud.githubusercontent.com/assets/1544760/7976088/b58f4e50-0a76-11e5-9e70-86450d937030.gif)2c3705 | The current commit hash. Here "2c3705" +| None | None | ![icon_git](https://cloud.githubusercontent.com/assets/1544760/7976092/b5909f80-0a76-11e5-9950-1438b9d72465.gif) | Repository is a git repository +| None | None | ![icon_mercurial](https://cloud.githubusercontent.com/assets/1544760/7976090/b5908da6-0a76-11e5-8c91-452b6e73f631.gif) | Repository is a Mercurial repository ### Styling -- cgit v1.2.3 From d65aea3a64f125b9f9768218a9165b591d49e46c Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Fri, 5 Jun 2015 19:23:32 +0200 Subject: Added more Icons, that work in `compatible` mode. --- README.md | 4 ++-- powerlevel9k.zsh-theme | 22 +++++++++++----------- 2 files changed, 13 insertions(+), 13 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c62b7da0..dbcb14f6 100644 --- a/README.md +++ b/README.md @@ -165,12 +165,12 @@ set. |--------------|---------------------|-------------------|-------------------------- | `↑4` | `↑4` | ![icon_outgoing](https://cloud.githubusercontent.com/assets/1544760/7976089/b5904d6e-0a76-11e5-8147-5e873ac52d79.gif)4 | Number of commits your repository is ahead of your remote branch | `↓5` | `↓5` | ![icon_incoming](https://cloud.githubusercontent.com/assets/1544760/7976091/b5909c9c-0a76-11e5-9cad-9bf0a28a897c.gif)5 | Number of commits your repository is behind of your remote branch -| None | `⍟3` | ![icon_stash](https://cloud.githubusercontent.com/assets/1544760/7976094/b5ae9346-0a76-11e5-8cc7-e98b81824118.gif)3 | Number of stashes, here 3. +| `⍟3` | `⍟3` | ![icon_stash](https://cloud.githubusercontent.com/assets/1544760/7976094/b5ae9346-0a76-11e5-8cc7-e98b81824118.gif)3 | Number of stashes, here 3. | `●` | `●` | ![icon_unstaged](https://cloud.githubusercontent.com/assets/1544760/7976096/b5aefa98-0a76-11e5-9408-985440471215.gif) | There are unstaged changes in your working copy | `✚` | `✚` | ![icon_staged](https://cloud.githubusercontent.com/assets/1544760/7976095/b5aecc8a-0a76-11e5-8988-221afc6e8982.gif) | There are staged changes in your working copy | `?` | `?` | ![icon_untracked](https://cloud.githubusercontent.com/assets/1544760/7976098/b5c7a2e6-0a76-11e5-8c5b-315b595b2bc4.gif) | There are files in your working copy, that are unknown to your repository | `→` | `→` | ![icon_remote_tracking_branch](https://cloud.githubusercontent.com/assets/1544760/7976093/b5ad2c0e-0a76-11e5-9cd3-62a077b1b0c7.gif) | The name of your branch differs from its tracking branch. -| None | `☿` | ![icon_bookmark](https://cloud.githubusercontent.com/assets/1544760/7976197/546cfac6-0a78-11e5-88a6-ce3a1e0a174e.gif) | A mercurial bookmark is active. +| `☿` | `☿` | ![icon_bookmark](https://cloud.githubusercontent.com/assets/1544760/7976197/546cfac6-0a78-11e5-88a6-ce3a1e0a174e.gif) | A mercurial bookmark is active. | `@` | ![icon_branch_powerline](https://cloud.githubusercontent.com/assets/1544760/8000852/e7e8d8a0-0b5f-11e5-9834-de9b25c92284.gif) | ![](https://cloud.githubusercontent.com/assets/1544760/7976087/b58bbe3e-0a76-11e5-8d0d-7a5c1bc7f730.gif) | Branch Icon | None | None | ![icon_commit](https://cloud.githubusercontent.com/assets/1544760/7976088/b58f4e50-0a76-11e5-9e70-86450d937030.gif)2c3705 | The current commit hash. Here "2c3705" | None | None | ![icon_git](https://cloud.githubusercontent.com/assets/1544760/7976092/b5909f80-0a76-11e5-9950-1438b9d72465.gif) | Repository is a git repository diff --git a/powerlevel9k.zsh-theme b/powerlevel9k.zsh-theme index 04e7183d..a02e9d4b 100644 --- a/powerlevel9k.zsh-theme +++ b/powerlevel9k.zsh-theme @@ -58,8 +58,8 @@ case $POWERLEVEL9K_MODE in AWS_ICON="\uE895" #  BACKGROUND_JOBS_ICON="\uE82F " #  TEST_ICON="\uE891" #  - OK_ICON="\u2713" # ✓ - FAIL_ICON="\u2718" # ✘ + OK_ICON="\u2713" # ✓ + FAIL_ICON="\u2718" # ✘ VCS_UNTRACKED_ICON="\uE16C" #  VCS_UNSTAGED_ICON="\uE17C" #  VCS_STAGED_ICON="\uE168" #  @@ -81,21 +81,21 @@ case $POWERLEVEL9K_MODE in 'compatible') LEFT_SEGMENT_SEPARATOR="\u2B80" # ⮀ RIGHT_SEGMENT_SEPARATOR="\u2B82" # ⮂ - ROOT_ICON='*R*' + ROOT_ICON="\u26A1" # ⚡ RUBY_ICON='' AWS_ICON="AWS:" BACKGROUND_JOBS_ICON="\u2699" # ⚙ TEST_ICON='' - OK_ICON='' - FAIL_ICON='x' + OK_ICON="\u2713" # ✓ + FAIL_ICON="\u2718" # ✘ VCS_UNTRACKED_ICON='?' VCS_UNSTAGED_ICON="\u25CF" # ● VCS_STAGED_ICON="\u271A" # ✚ - VCS_STASH_ICON='' + VCS_STASH_ICON="\u235F" # ⍟ VCS_INCOMING_CHANGES="\u2193" # ↓ VCS_OUTGOING_CHANGES="\u2191" # ↑ VCS_TAG_ICON='' - VCS_BOOKMARK_ICON='' + VCS_BOOKMARK_ICON="\u263F" # ☿ VCS_COMMIT_ICON='' VCS_BRANCH_ICON='@' VCS_REMOTE_BRANCH_ICON="\u2192" # → @@ -111,8 +111,8 @@ case $POWERLEVEL9K_MODE in AWS_ICON="\uE895" #  BACKGROUND_JOBS_ICON="\uE82F " #  TEST_ICON="\uE891" #  - OK_ICON="\u2713" # ✓ - FAIL_ICON="\u2718" # ✘ + OK_ICON="\u2713" # ✓ + FAIL_ICON="\u2718" # ✘ VCS_UNTRACKED_ICON="\uE16C" #  VCS_UNSTAGED_ICON="\uE17C" #  VCS_STAGED_ICON="\uE168" #  @@ -140,8 +140,8 @@ case $POWERLEVEL9K_MODE in AWS_ICON="AWS:" BACKGROUND_JOBS_ICON="\u2699" # ⚙ TEST_ICON='' - OK_ICON="\u2713" # ✓ - FAIL_ICON="\u2718" # ✘ + OK_ICON="\u2713" # ✓ + FAIL_ICON="\u2718" # ✘ VCS_UNTRACKED_ICON='?' VCS_UNSTAGED_ICON="\u25CF" # ● VCS_STAGED_ICON="\u271A" # ✚ -- cgit v1.2.3 From 3f074d5e984e379f518bbdb43a9b11d934781f6a Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Fri, 5 Jun 2015 17:17:35 -0700 Subject: README: Changes / reorg regarding new font options --- README.md | 89 ++++++++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 62 insertions(+), 27 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index dbcb14f6..c7fdb61d 100644 --- a/README.md +++ b/README.md @@ -63,10 +63,12 @@ Here are some screenshots of `powerlevel9k` with default settings: ### Installation +There are three different forms of installation that you can use to make use of +this theme: -You just need to install the theme and set `POWERLEVEL9K_MODE='compatible'` -to join the experience. If you want to customize your experience even further -read the chapter about "[fonts](#fonts)" or about "[segment customization](#segment-customization)". +* Normal - Theme + Powerline Fonts +* Über - Theme + Awesome Powerline Fonts +* Bare Bones - Theme Only #### Install Powerlevel9k @@ -80,6 +82,60 @@ You then need to select this theme in your `~/.zshrc`: ZSH_THEME="powerlevel9k/powerlevel9k" + +#### Install Powerline Fonts for Normal Configuration + +You can find the [installation instructions for Powerline Fonts 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) if you want to manually install +them for your OS. + +After you have installed Powerline fonts, make the default font in your terminal +emulator the Powerline font you want to use. + +This is the default mode for `Powerlevel9k`, and no further configuration is +necessary. + +#### Alternative Configuration: Über + +Alternatively, you can install [Awesome Powerline +Fonts](https://github.com/gabrielelana/awesome-terminal-fonts/tree/patching-strategy/patched), +which provide a number of additional glyphs. + +You then need to indicate that you wish to use the additional glyphs by defining +the following in your `~/.zshrc`: + + POWERLEVEL9K_MODE='awesome-patched' + +If you choose to make use of this, your prompt will look something like this: + +![](https://cloud.githubusercontent.com/assets/1544760/7959660/67612918-09fb-11e5-9ef2-2308363c3c51.png) + +Note that if you prefer flat segment transitions, you can use the following with +`Awesome Powerline Fonts` installed: + + POWERLEVEL9K_MODE='flat' + +Which looks like this: + +![](https://cloud.githubusercontent.com/assets/1544760/7981324/76d0eb5a-0aae-11e5-9608-d662123d0b0a.png) + +#### Alternative Configuration: Bare Bones + +This option is best if you prefer not to install additional fonts. This option +will work out-of-the-box if your your terminal font supports the segment +separator characters `\uE0B0` (left segment separator) and `\uE0B2` (right +segment separator). + +All you need to do to in this case is install the `Powerlevel9k` theme itself, +as explained above, and then define the following in your `~/.zshrc`: + + POWERLEVEL9K_MODE='compatible' + +Note that depending on your terminal font, this may still not render +appropriately. This configuration should be used as a back-up. + ### Segment Customization Customizing your prompt is easy! Select the segments you want to have displayed, @@ -158,10 +214,10 @@ Example: ##### Symbols The `vcs` segment uses various symbols to tell you the state of your repository. -These symbols depend on your installed [Font](#fonts) and your `POWERLEVEL9K_MODE` -set. +These symbols depend on your installed font and selected `POWERLEVEL9K_MODE` +from the [Installation](#Installation) section above. -| `compatible` | `powerline-patched` | `awesome-patched` | explanation +| `Bare Bones` | `Normal` | `Über` | explanation |--------------|---------------------|-------------------|-------------------------- | `↑4` | `↑4` | ![icon_outgoing](https://cloud.githubusercontent.com/assets/1544760/7976089/b5904d6e-0a76-11e5-8147-5e873ac52d79.gif)4 | Number of commits your repository is ahead of your remote branch | `↓5` | `↓5` | ![icon_incoming](https://cloud.githubusercontent.com/assets/1544760/7976091/b5909c9c-0a76-11e5-9cad-9bf0a28a897c.gif)5 | Number of commits your repository is behind of your remote branch @@ -181,27 +237,6 @@ set. You can configure the look and feel of your prompt easily with some built-in options. -#### Fonts - -If you set `POWERLEVEL9K_MODE='compatible'` you just get a little glimpse of -the beauty of this theme. - -To get nicer Icons you need to install a [powerline-patched](https://github.com/Lokaltog/powerline-fonts) font. -In your terminal emulator you need to select this font and in your `~/.zshrc` you need -to set `POWERLEVEL9K_MODE='powerline-patched'`. -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) if you want to manually install them for your OS. -Screenshot: -![](http://bhilburn.org/content/images/2015/01/pl9k-improved.png) - -If even these Icons did not impress you, have a look at `POWERLEVEL9K_MODE='awesome-patched'`. -For this mode, you have to install a [awesome-patched](https://github.com/gabrielelana/awesome-terminal-fonts/tree/patching-strategy/patched) font and set the according mode. -Screenshot: -![](https://cloud.githubusercontent.com/assets/1544760/7959660/67612918-09fb-11e5-9ef2-2308363c3c51.png) - -If you prefer segements as rectangles, just set `POWERLEVEL9K_MODE='flat'`, but -beware: You still need a [awesome-patched](https://github.com/gabrielelana/awesome-terminal-fonts/tree/patching-strategy/patched) font. - #### Double-Lined Prompt By default, `powerlevel9k` is a single-lined prompt. If you would like to have -- cgit v1.2.3 From 9a507fbdae016d1250f5a63c705361c207bee290 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Fri, 5 Jun 2015 17:26:00 -0700 Subject: Minor changes to docs in README and theme file. --- README.md | 4 ++-- powerlevel9k.zsh-theme | 10 +++++++--- 2 files changed, 9 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c7fdb61d..e74adf7e 100644 --- a/README.md +++ b/README.md @@ -100,8 +100,8 @@ necessary. #### Alternative Configuration: Über Alternatively, you can install [Awesome Powerline -Fonts](https://github.com/gabrielelana/awesome-terminal-fonts/tree/patching-strategy/patched), -which provide a number of additional glyphs. +Fonts](https://github.com/gabrielelana/awesome-terminal-fonts), which provide +a number of additional glyphs. You then need to indicate that you wish to use the additional glyphs by defining the following in your `~/.zshrc`: diff --git a/powerlevel9k.zsh-theme b/powerlevel9k.zsh-theme index a02e9d4b..0fb515fe 100644 --- a/powerlevel9k.zsh-theme +++ b/powerlevel9k.zsh-theme @@ -46,11 +46,13 @@ CURRENT_BG='NONE' # These characters require the Powerline fonts to work properly. If see boxes or -# bizarre characters below, your fonts are not correctly installed. In case you +# bizarre characters below, your fonts are not correctly installed. If you # do not want to install a special font, you can set `POWERLEVEL9K_MODE` to # `compatible`. This shows all icons in regular symbols. case $POWERLEVEL9K_MODE in 'flat') + # Awesome-Patched Font required! + # See https://github.com/gabrielelana/awesome-terminal-fonts/tree/patching-strategy/patched LEFT_SEGMENT_SEPARATOR='' RIGHT_SEGMENT_SEPARATOR='' ROOT_ICON="\uE801" #  @@ -103,7 +105,8 @@ case $POWERLEVEL9K_MODE in VCS_HG_ICON='HG' ;; 'awesome-patched') - # Awesome-Patched Font required! See https://github.com/gabrielelana/awesome-terminal-fonts/tree/patching-strategy/patched + # Awesome-Patched Font required! + # See https://github.com/gabrielelana/awesome-terminal-fonts/tree/patching-strategy/patched LEFT_SEGMENT_SEPARATOR="\uE0B0" #  RIGHT_SEGMENT_SEPARATOR="\uE0B2" #  ROOT_ICON="\u26A1" # ⚡ @@ -132,7 +135,8 @@ case $POWERLEVEL9K_MODE in VCS_HG_ICON="\uE1C3 " #  ;; *) - # Powerline-Patched Font required! See https://github.com/Lokaltog/powerline-fonts + # Powerline-Patched Font required! + # See https://github.com/Lokaltog/powerline-fonts LEFT_SEGMENT_SEPARATOR="\uE0B0" #  RIGHT_SEGMENT_SEPARATOR="\uE0B2" #  ROOT_ICON="\u26A1" # ⚡ -- cgit v1.2.3 From 6a0925ac962d921d74577a1f2c09254178737977 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Sat, 6 Jun 2015 18:21:57 +0200 Subject: Updated TOC. --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e74adf7e..9da57cb8 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,20 @@ information in configurable prompt segments. - [Features](#features) - [Installation](#installation) - [Install Powerlevel9k](#install-powerlevel9k) + - [Install Powerline Fonts for Normal Configuration](#install-powerline-fonts-for-normal-configuration) + - [Alternative Configuration: Über](#alternative-configuration-%C3%BCber) + - [Alternative Configuration: Bare Bones](#alternative-configuration-bare-bones) - [Segment Customization](#segment-customization) - [The AWS Profile Segment](#the-aws-profile-segment) - [The 'context' Segment](#the-context-segment) - - [Test ratio](#test-ratio) - [The 'time' segment](#the-time-segment) + - [Unit Test Ratios](#unit-test-ratios) - [The 'vcs' Segment](#the-vcs-segment) - [Symbols](#symbols) - [Styling](#styling) - - [Fonts](#fonts) - [Double-Lined Prompt](#double-lined-prompt) - [Light Color Theme](#light-color-theme) + - [Further color customizations](#further-color-customizations) - [Troubleshooting](#troubleshooting) - [Gaps Between Segments](#gaps-between-segments) - [Contributions / Bugs / Contact](#contributions--bugs--contact) -- cgit v1.2.3 From fea1d7ec5e21be22f7bd58480a323f4509ff656e Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Sun, 7 Jun 2015 01:11:06 +0200 Subject: Added documentation. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index dc8798fe..e3a382fa 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,14 @@ elements (it is by default), and define a `DEFAULT_USER` in your `~/.zshrc`: export DEFAULT_USER= +#### The `dir` segment + +The `dir` segment shows the current working directory. You can limit the output +to a certain length: + + # Limit to 20 characters + POWERLEVEL9K_SHORTEN_PWD_LENGTH=20 + #### The 'time' segment By default the time is show in 'H:M:S' format. If you want to change it, -- cgit v1.2.3 From 891f5567fd198220cd2b7b4e471a465ac736579e Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Sun, 7 Jun 2015 01:48:02 +0200 Subject: Limit to whole folders, not just characters. --- README.md | 4 ++-- powerlevel9k.zsh-theme | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e3a382fa..10610c3f 100644 --- a/README.md +++ b/README.md @@ -115,8 +115,8 @@ elements (it is by default), and define a `DEFAULT_USER` in your `~/.zshrc`: The `dir` segment shows the current working directory. You can limit the output to a certain length: - # Limit to 20 characters - POWERLEVEL9K_SHORTEN_PWD_LENGTH=20 + # Limit to the last two folders + POWERLEVEL9K_SHORTEN_DIR_LENGTH=2 #### The 'time' segment diff --git a/powerlevel9k.zsh-theme b/powerlevel9k.zsh-theme index 1cd6a870..a049f863 100644 --- a/powerlevel9k.zsh-theme +++ b/powerlevel9k.zsh-theme @@ -319,9 +319,9 @@ prompt_context() { # Dir: current working directory prompt_dir() { local current_path='%~' - if [[ -n "$POWERLEVEL9K_SHORTEN_PWD_LENGTH" ]]; then - # shorten path to $POWERLEVEL9K_SHORTEN_PWD_LENGTH characters - local current_path="%${POWERLEVEL9K_SHORTEN_PWD_LENGTH}<..<%~%<<" + if [[ -n "$POWERLEVEL9K_SHORTEN_DIR_LENGTH" ]]; then + # shorten path to $POWERLEVEL9K_SHORTEN_DIR_LENGTH + current_path="%$((POWERLEVEL9K_SHORTEN_DIR_LENGTH+1))(c:.../:)%${POWERLEVEL9K_SHORTEN_DIR_LENGTH}c" fi $1_prompt_segment $0 blue $DEFAULT_COLOR $current_path -- cgit v1.2.3 From c78bdf95045cfcb3c8b683724ed95129861eabad Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Mon, 8 Jun 2015 13:47:39 -0700 Subject: README: Updating picture location --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9da57cb8..5427212f 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,10 @@ giving you the most epic terminal styling in the universe. Look like a bad-ass. Impress everyone in 'Screenshot Your Desktop' threads. Use powerlevel9k. In addition to looking amazing, this theme actually provides a lot of useful -information in configurable prompt segments. +information in configurable prompt segments. Here is an example of what it looks +like with a normal installation and default settings: + +![](http://bhilburn.org/content/images/2015/01/pl9k-improved.png) @@ -58,13 +61,11 @@ information in configurable prompt segments. doesn't require Powerline fonts, check out the sister font, [hackersaurus](https://github.com/bhilburn/hackersaurus).** -Here are some screenshots of `powerlevel9k` with default settings: +Here is a detailed screenshot showing `powerlevel9k` with default settings and +varying terminal status indicators: ![](http://bhilburn.org/content/images/2014/12/powerlevel9k.png) -![](http://bhilburn.org/content/images/2015/01/pl9k-improved.png) - - ### Installation There are three different forms of installation that you can use to make use of this theme: -- cgit v1.2.3 From e97c216c7b6973e1ce80f3f76d0254e9f52ba894 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Thu, 11 Jun 2015 18:24:16 +0200 Subject: More Documentation. --- README.md | 51 ++++++++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 25 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e486a84e..2ba97554 100644 --- a/README.md +++ b/README.md @@ -76,34 +76,14 @@ this theme: #### Install Powerlevel9k -To install this theme, clone this repository into your Oh-My-Zsh `custom/themes` -directory. - - $ cd ~/.oh-my-zsh/custom - $ git clone https://github.com/bhilburn/powerlevel9k.git themes/powerlevel9k +##### With plain ZSH -You then need to select this theme in your `~/.zshrc`: +If you use just a plain ZSH, just clone this repository and reference it in your `~/.zshrc`: - ZSH_THEME="powerlevel9k/powerlevel9k" - - -#### Install Powerline Fonts for Normal Configuration - -You can find the [installation instructions for Powerline Fonts 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) if you want to manually install -them for your OS. - -After you have installed Powerline fonts, make the default font in your terminal -emulator the Powerline font you want to use. - -This is the default mode for `Powerlevel9k`, and no further configuration is -necessary. - -#### Install Powerlevel9k + $ git clone https://github.com/bhilburn/powerlevel9k.git + $ echo 'source powerlevel9k/powerlevel9k.zsh-theme' >> ~/.zshrc -##### Within Oh-my-ZSH +##### With Oh-my-ZSH To install this theme, clone this repository into your [Oh-my-Zsh](https://github.com/robbyrussell/oh-my-zsh) `custom/themes` directory. @@ -128,6 +108,27 @@ You then need to select this theme in your `~/.zpreztorc`: zstyle ':prezto:module:prompt' theme 'powerlevel9k' +##### With antigen + +If you prefer [antigen](https://github.com/zsh-users/antigen), just add it to your `~/.zshrc`: + + $ echo 'antigen theme /vagrant_data powerlevel9k' >> ~/.zshrc + $ echo 'antigen apply' >> ~/.zshrc + +#### Install Powerline Fonts for Normal Configuration + +You can find the [installation instructions for Powerline Fonts 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) if you want to manually install +them for your OS. + +After you have installed Powerline fonts, make the default font in your terminal +emulator the Powerline font you want to use. + +This is the default mode for `Powerlevel9k`, and no further configuration is +necessary. + #### Alternative Configuration: Über Alternatively, you can install [Awesome Powerline -- cgit v1.2.3 From 2821a0deee22cbb4884023e7343e22901b997c05 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Thu, 11 Jun 2015 18:24:55 +0200 Subject: Updated TOC. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 2ba97554..4b430a44 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,10 @@ like with a normal installation and default settings: - [Features](#features) - [Installation](#installation) - [Install Powerlevel9k](#install-powerlevel9k) + - [With plain ZSH](#with-plain-zsh) + - [With Oh-my-ZSH](#with-oh-my-zsh) + - [With Prezto](#with-prezto) + - [With antigen](#with-antigen) - [Install Powerline Fonts for Normal Configuration](#install-powerline-fonts-for-normal-configuration) - [Alternative Configuration: Über](#alternative-configuration-%C3%BCber) - [Alternative Configuration: Bare Bones](#alternative-configuration-bare-bones) -- cgit v1.2.3 From 1e7105918d4505532eb6183254bfa15176711f10 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Thu, 11 Jun 2015 19:50:30 +0200 Subject: Added a reference to the test-vm folder --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 4b430a44..2f71441c 100644 --- a/README.md +++ b/README.md @@ -370,3 +370,6 @@ Please submit your contribution as a Github pull-request. If you would like to contact me directly, you can find my e-mail address on my [Github profile page](https://github.com/bhilburn). +### Testing + +Check out the [vagrant](https://www.vagrantup.com/) configuration in the [test-vm](test-vm) folder. -- cgit v1.2.3 From 5bbe8aa6ffc8187eb123a00f280b790ce4d52896 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Sun, 28 Jun 2015 17:19:22 -0700 Subject: README: Removing reference to un-merged Vagrant test VM --- README.md | 3 --- 1 file changed, 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2f71441c..4b430a44 100644 --- a/README.md +++ b/README.md @@ -370,6 +370,3 @@ Please submit your contribution as a Github pull-request. If you would like to contact me directly, you can find my e-mail address on my [Github profile page](https://github.com/bhilburn). -### Testing - -Check out the [vagrant](https://www.vagrantup.com/) configuration in the [test-vm](test-vm) folder. -- cgit v1.2.3 From f84a14419400854f84ed70676fe0296de86480f7 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Sun, 28 Jun 2015 17:57:28 -0700 Subject: README: Updating to reflect new system support --- README.md | 100 ++++++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 68 insertions(+), 32 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4b430a44..db25c295 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ -## powerlevel9k Theme for Oh-My-Zsh +## powerlevel9k Theme for 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 epic terminal styling in the universe. +Powerlevel9k is a theme for ZSH which uses [Powerline +Fonts](https://github.com/Lokaltog/powerline-fonts), thus giving you the most +epic terminal styling in the universe. Look like a bad-ass. Impress everyone in 'Screenshot Your Desktop' threads. Use powerlevel9k. +Powerlevel9k can be used with vanilla ZSH, +[Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh), or +[Prezto](https://github.com/sorin-ionescu/prezto), and can also be installed +using [antigen](https://github.com/zsh-users/antigen). + + In addition to looking amazing, this theme actually provides a lot of useful information in configurable prompt segments. Here is an example of what it looks like with a normal installation and default settings: @@ -18,14 +24,15 @@ like with a normal installation and default settings: - [Features](#features) - [Installation](#installation) - - [Install Powerlevel9k](#install-powerlevel9k) - - [With plain ZSH](#with-plain-zsh) - - [With Oh-my-ZSH](#with-oh-my-zsh) - - [With Prezto](#with-prezto) - - [With antigen](#with-antigen) - - [Install Powerline Fonts for Normal Configuration](#install-powerline-fonts-for-normal-configuration) - - [Alternative Configuration: Über](#alternative-configuration-%C3%BCber) - - [Alternative Configuration: Bare Bones](#alternative-configuration-bare-bones) + - [Step 1: Install Powerlevel9k](#step-1-install-powerlevel9k) + - [Option 1: Install for Vanilla ZSH](#option-1-install-for-vanilla-zsh) + - [Option 2: Install for Oh-My-ZSH](#option-2-install-for-oh-my-zsh) + - [Option 3: Install for Prezto](#option-3-install-for-prezto) + - [Option 4: Install for antigen](#option-4-install-for-antigen) + - [Step 2: Install Powerline Fonts](#step-2-install-powerline-fonts) + - [Option 1: Install Powerline Fonts](#option-1-install-powerline-fonts) + - [Option 2: Install Awesome Powerline Fonts](#option-2-install-awesome-powerline-fonts) + - [Option 3: Compatible Mode](#option-3-compatible-mode) - [Segment Customization](#segment-customization) - [The AWS Profile Segment](#the-aws-profile-segment) - [The 'context' Segment](#the-context-segment) @@ -55,7 +62,7 @@ like with a normal installation and default settings: * various working tree statuses (e.g., unstaged, staged, etc.,) * Shows return-code of the last command if it is an error code * Indicates background jobs with a gear icon -* Can conditionally display the `user@host` string when needed +* Can conditionally display the `user@host` string when needed (e.g., SSH) * Provides segment for command history (so you can `$ !` to re-run) * Plenty of additional segments to choose from (e.g., AWS, ruby) * Can be used as a single or double-lined prompt (see screenshots below) @@ -71,26 +78,38 @@ varying terminal status indicators: ![](http://bhilburn.org/content/images/2014/12/powerlevel9k.png) ### Installation -There are three different forms of installation that you can use to make use of -this theme: +There are two steps to start using this theme: + +1. Install the Powerlevel9k theme. +2. Install Powerline-patched fonts. +3. [Optional] Configuration + +To get the most out of Powerlevel9k, you need to install both the theme as well +as Powerline-patched fonts, if you don't have them installed already. If you +cannot install Powerline-patched fonts for some reason, follow the instructions +below for a `compatible` install. -* Normal - Theme + Powerline Fonts -* Über - Theme + Awesome Powerline Fonts -* Bare Bones - Theme Only +No configuration is necessary post-installation if you like the default +settings, but there is plenty of segment configuration available if you are +interested. -#### Install Powerlevel9k +#### Step 1: Install Powerlevel9k +There are four ways to install and use the Powerlevel9k theme: vanilla ZSH, +Oh-My-Zsh, Prezto, and antigen. Do one of the following: -##### With plain ZSH +##### Option 1: Install for Vanilla ZSH -If you use just a plain ZSH, just clone this repository and reference it in your `~/.zshrc`: +If you use just a vanilla ZSH install, simply clone this repository and +reference it in your `~/.zshrc`: $ git clone https://github.com/bhilburn/powerlevel9k.git $ echo 'source powerlevel9k/powerlevel9k.zsh-theme' >> ~/.zshrc -##### With Oh-my-ZSH +##### Option 2: Install for Oh-My-ZSH -To install this theme, clone this repository into your [Oh-my-Zsh](https://github.com/robbyrussell/oh-my-zsh) `custom/themes` -directory. +To install this theme for +[Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh), clone this repository +into your OMZ `custom/themes` directory. $ cd ~/.oh-my-zsh/custom $ git clone https://github.com/bhilburn/powerlevel9k.git themes/powerlevel9k @@ -99,10 +118,10 @@ You then need to select this theme in your `~/.zshrc`: ZSH_THEME="powerlevel9k/powerlevel9k" -##### With Prezto +##### Option 3: Install for Prezto -To install this theme, clone this repository into your [Prezto](https://github.com/sorin-ionescu/prezto) `prompt/external` -directory. +To install this theme for use in Prezto, clone this repository into your +[Prezto](https://github.com/sorin-ionescu/prezto) `prompt/external` directory. $ cd ~.zprezto/modules/prompt/external $ git clone https://github.com/bhilburn/powerlevel9k.git @@ -112,14 +131,27 @@ You then need to select this theme in your `~/.zpreztorc`: zstyle ':prezto:module:prompt' theme 'powerlevel9k' -##### With antigen +##### Option 4: Install for antigen -If you prefer [antigen](https://github.com/zsh-users/antigen), just add it to your `~/.zshrc`: +If you prefer [antigen](https://github.com/zsh-users/antigen), just add this +theme to the antigen config in your `~/.zshrc`: $ echo 'antigen theme /vagrant_data powerlevel9k' >> ~/.zshrc $ echo 'antigen apply' >> ~/.zshrc -#### Install Powerline Fonts for Normal Configuration +#### Step 2: Install Powerline Fonts +Technically, you don't *have* to install Powerline fonts. If you are using +a font that has some of the basic glyphs we need, you can use the theme in +`compatible` mode - see the third option, below. + +To get the most out of theme, though, you'll want Powerline-patched fonts. There +are two varieties of these: 'Powerline Fonts' and 'Awesome Powerline +Fonts'. The latter includes additional glyphs that aren't required for a normal +install. + +Do one of the following: + +##### Option 1: Install Powerline Fonts You can find the [installation instructions for Powerline Fonts here] (https://powerline.readthedocs.org/en/latest/installation/linux.html#fonts-installation). @@ -133,7 +165,11 @@ emulator the Powerline font you want to use. This is the default mode for `Powerlevel9k`, and no further configuration is necessary. -#### Alternative Configuration: Über +**N.B.:** If Powerlevel9k is not working properly, it is almost always the case +that the fonts were not properly installed, or you have not configured your +terminal to use a Powerline-patched font! + +##### Option 2: Install Awesome Powerline Fonts Alternatively, you can install [Awesome Powerline Fonts](https://github.com/gabrielelana/awesome-terminal-fonts), which provide @@ -157,7 +193,7 @@ Which looks like this: ![](https://cloud.githubusercontent.com/assets/1544760/7981324/76d0eb5a-0aae-11e5-9608-d662123d0b0a.png) -#### Alternative Configuration: Bare Bones +##### Option 3: Compatible Mode This option is best if you prefer not to install additional fonts. This option will work out-of-the-box if your your terminal font supports the segment -- cgit v1.2.3 From d2a0346bf11b28ffe42ae90657d7a232234a06fd Mon Sep 17 00:00:00 2001 From: Daniel Sager Date: Mon, 29 Jun 2015 07:54:56 +0200 Subject: updated info for antigen install option --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index db25c295..80ae1f46 100644 --- a/README.md +++ b/README.md @@ -136,9 +136,12 @@ You then need to select this theme in your `~/.zpreztorc`: If you prefer [antigen](https://github.com/zsh-users/antigen), just add this theme to the antigen config in your `~/.zshrc`: - $ echo 'antigen theme /vagrant_data powerlevel9k' >> ~/.zshrc + $ echo 'antigen theme bhilburn/powerlevel9k powerlevel9k' >> ~/.zshrc $ echo 'antigen apply' >> ~/.zshrc +Note that you should define any customizations before calling `antigen theme` +(i.e. setting the `POWERLEVEL9K_*` variables) in your `.zshrc`. + #### Step 2: Install Powerline Fonts Technically, you don't *have* to install Powerline fonts. If you are using a font that has some of the basic glyphs we need, you can use the theme in -- cgit v1.2.3 From 8950a0a6e307a15c32bf3347323c5ebdd136f87f Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Tue, 30 Jun 2015 14:40:01 -0700 Subject: README: Adding note about theme inspiration. --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 80ae1f46..0cea87d6 100644 --- a/README.md +++ b/README.md @@ -398,13 +398,20 @@ Thankfully, this is easy to fix. This happens if you have successfully installed Powerline fonts, but did not make a Powerline font the default font in your terminal emulator (e.g., 'terminator', 'gnome-terminal', 'konsole', etc.,). -### Contributions / Bugs / Contact +### Meta + +#### Kudos + +This theme wouldn't have happened without inspiration from the original [agnoster](https://gist.github.com/agnoster/3712874) Oh-My-ZSH theme. + +Before creating this theme, I also tried [jeremyFreeAgent's theme](https://github.com/jeremyFreeAgent/oh-my-zsh-powerline-theme) and [maverick2000's theme ZSH2000](https://github.com/maverick2000/zsh2000). + +#### Contributions / Bugs / Contact If you have any requests or bug reports, please use the tracker in this Github repository. -I'm happy to accept code contributions from anyone who has an improvement! -Please submit your contribution as a Github pull-request. +I'm happy to accept code contributions from anyone who has a bug fix, new feature, or just a general improvement! Please submit your contribution as a Github pull-request. If you would like to contact me directly, you can find my e-mail address on my [Github profile page](https://github.com/bhilburn). -- cgit v1.2.3 From 558d137bfaf3b64c5e1b6b1091b0c066cb5f5cce Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Tue, 30 Jun 2015 14:40:42 -0700 Subject: README: Silly missing comma. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0cea87d6..c406835c 100644 --- a/README.md +++ b/README.md @@ -404,7 +404,7 @@ terminal emulator (e.g., 'terminator', 'gnome-terminal', 'konsole', etc.,). This theme wouldn't have happened without inspiration from the original [agnoster](https://gist.github.com/agnoster/3712874) Oh-My-ZSH theme. -Before creating this theme, I also tried [jeremyFreeAgent's theme](https://github.com/jeremyFreeAgent/oh-my-zsh-powerline-theme) and [maverick2000's theme ZSH2000](https://github.com/maverick2000/zsh2000). +Before creating this theme, I also tried [jeremyFreeAgent's theme](https://github.com/jeremyFreeAgent/oh-my-zsh-powerline-theme) and [maverick2000's theme, ZSH2000](https://github.com/maverick2000/zsh2000). #### Contributions / Bugs / Contact -- cgit v1.2.3 From f1b5b783d3c8daabf427dfc8c1baf6a9145d7c62 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Sun, 24 May 2015 19:34:46 +0100 Subject: Added a segment that shows the Symfony2 version number. --- README.md | 1 + powerlevel9k.zsh-theme | 12 ++++++++++++ 2 files changed, 13 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index c406835c..b56c6cd2 100644 --- a/README.md +++ b/README.md @@ -225,6 +225,7 @@ currently available are: * **rspec_stats** - Show a ratio of test classes vs code classes for RSpec. * **status** - The return code of the previous command, and status of background jobs. * **symfony2_tests** - Show a ratio of test classes vs code classes for Symfony2. +* **symfony2_version** - Show the current Symfony2 version, if you are in a Symfony2-Project dir. * **time** - System time. * **virtualenv** - Your Python [VirtualEnv](https://virtualenv.pypa.io/en/latest/). * **vcs** - Information about this `git` or `hg` repository (if you are in one). diff --git a/powerlevel9k.zsh-theme b/powerlevel9k.zsh-theme index 1ebc31bb..ef9b1b3b 100644 --- a/powerlevel9k.zsh-theme +++ b/powerlevel9k.zsh-theme @@ -61,6 +61,7 @@ case $POWERLEVEL9K_MODE in TEST_ICON="\uE891" #  OK_ICON="\u2713" # ✓ FAIL_ICON="\u2718" # ✘ + SYMFONY_ICON="SF" VCS_UNTRACKED_ICON="\uE16C" #  VCS_UNSTAGED_ICON="\uE17C" #  VCS_STAGED_ICON="\uE168" #  @@ -90,6 +91,7 @@ case $POWERLEVEL9K_MODE in TEST_ICON='' OK_ICON="\u2713" # ✓ FAIL_ICON="\u2718" # ✘ + SYMFONY_ICON="SF" VCS_UNTRACKED_ICON='?' VCS_UNSTAGED_ICON="\u25CF" # ● VCS_STAGED_ICON="\u271A" # ✚ @@ -117,6 +119,7 @@ case $POWERLEVEL9K_MODE in TEST_ICON="\uE891" #  OK_ICON="\u2713" # ✓ FAIL_ICON="\u2718" # ✘ + SYMFONY_ICON="SF" VCS_UNTRACKED_ICON="\uE16C" #  VCS_UNSTAGED_ICON="\uE17C" #  VCS_STAGED_ICON="\uE168" #  @@ -148,6 +151,7 @@ case $POWERLEVEL9K_MODE in TEST_ICON='' OK_ICON="\u2713" # ✓ FAIL_ICON="\u2718" # ✘ + SYMFONY_ICON="SF" VCS_UNTRACKED_ICON='?' VCS_UNSTAGED_ICON="\u25CF" # ● VCS_STAGED_ICON="\u271A" # ✚ @@ -510,6 +514,14 @@ prompt_symfony2_tests() { fi } +# Symfony2-Version +prompt_symfony2_version() { + if [[ -f app/bootstrap.php.cache ]]; then + local symfony2_version=$(grep " VERSION " app/bootstrap.php.cache | sed -e 's/[^.0-9]*//g') + $1_prompt_segment "$0" "240" "$DEFAULT_COLOR" "$SYMFONY_ICON $symfony2_version" + fi +} + # Show a ratio of tests vs code build_test_stats() { local code_amount="$3" -- cgit v1.2.3 From 2538e5579b2b69cf77342957b5fd436ccc4b20a2 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Wed, 8 Jul 2015 00:44:52 +0200 Subject: Make branch icon configurable. --- README.md | 6 +++++- powerlevel9k.zsh-theme | 16 ++++++++-------- 2 files changed, 13 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c406835c..2a90e730 100644 --- a/README.md +++ b/README.md @@ -278,13 +278,17 @@ By default, the `vcs` segment will provide quite a bit of information. If you would also like for it to display the current hash / changeset, simply define `POWERLEVEL9K_SHOW_CHANGESET` in your `~/.zshrc`. If activated, it will show the first 12 characters of the changeset id. To change the amount of characters, -set `POWERLEVEL9K_CHANGESET_HASH_LENTH` to any value you want. +set `POWERLEVEL9K_CHANGESET_HASH_LENGTH` to any value you want. +By setting `POWERLEVEL9K_SHOW_BRANCH_ICON` it shows a nice icon before the +branch name. Example: # enable the vcs segment in general POWERLEVEL9K_SHOW_CHANGESET=true # just show the 6 first characters of changeset POWERLEVEL9K_CHANGESET_HASH_LENGTH=6 + # Show an icon before the branch name + POWERLEVEL9K_SHOW_BRANCH_ICON=true ##### Symbols diff --git a/powerlevel9k.zsh-theme b/powerlevel9k.zsh-theme index 1ebc31bb..cee6acad 100644 --- a/powerlevel9k.zsh-theme +++ b/powerlevel9k.zsh-theme @@ -74,8 +74,7 @@ case $POWERLEVEL9K_MODE in VCS_TAG_ICON="\uE817 " #  VCS_BOOKMARK_ICON="\uE87B" #  VCS_COMMIT_ICON="\uE821 " #  - #VCS_BRANCH_ICON=" \uE220" #  - VCS_BRANCH_ICON='' + VCS_BRANCH_ICON=" \uE220" #  VCS_REMOTE_BRANCH_ICON="\uE804" #  VCS_GIT_ICON="\uE20E " #  VCS_HG_ICON="\uE1C3 " #  @@ -99,8 +98,7 @@ case $POWERLEVEL9K_MODE in VCS_TAG_ICON='' VCS_BOOKMARK_ICON="\u263F" # ☿ VCS_COMMIT_ICON='' - #VCS_BRANCH_ICON='@' - VCS_BRANCH_ICON='' + VCS_BRANCH_ICON='@' VCS_REMOTE_BRANCH_ICON="\u2192" # → VCS_GIT_ICON='Git' VCS_HG_ICON='HG' @@ -130,8 +128,7 @@ case $POWERLEVEL9K_MODE in VCS_TAG_ICON="\uE817 " #  VCS_BOOKMARK_ICON="\uE87B" #  VCS_COMMIT_ICON="\uE821 " #  - #VCS_BRANCH_ICON=" \uE220" #  - VCS_BRANCH_ICON='' + VCS_BRANCH_ICON=" \uE220" #  VCS_REMOTE_BRANCH_ICON="\uE804" #  VCS_GIT_ICON="\uE20E " #  VCS_HG_ICON="\uE1C3 " #  @@ -157,14 +154,17 @@ case $POWERLEVEL9K_MODE in VCS_TAG_ICON='' VCS_BOOKMARK_ICON="\u263F" # ☿ VCS_COMMIT_ICON='' - #VCS_BRANCH_ICON='@' - VCS_BRANCH_ICON='' + VCS_BRANCH_ICON='@' VCS_REMOTE_BRANCH_ICON="\u2192" # → VCS_GIT_ICON="\uE0A0" #  VCS_HG_ICON="\uE0A0" #  ;; esac +if [[ "$POWERLEVEL9K_SHOW_BRANCH_ICON" != true ]]; then + VCS_BRANCH_ICON='' +fi + ################################################################ # color scheme ################################################################ -- cgit v1.2.3 From 772c9ab85d82a87c0e7cf638ce4032697e217bc7 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Wed, 8 Jul 2015 18:52:30 -0700 Subject: README: Updating for branch icon, ToC --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c065d382..7d5a5f76 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,9 @@ like with a normal installation and default settings: - [Further color customizations](#further-color-customizations) - [Troubleshooting](#troubleshooting) - [Gaps Between Segments](#gaps-between-segments) -- [Contributions / Bugs / Contact](#contributions--bugs--contact) +- [Meta](#meta) + - [Kudos](#kudos) + - [Contributions / Bugs / Contact](#contributions--bugs--contact) @@ -280,14 +282,15 @@ would also like for it to display the current hash / changeset, simply define `POWERLEVEL9K_SHOW_CHANGESET` in your `~/.zshrc`. If activated, it will show the first 12 characters of the changeset id. To change the amount of characters, set `POWERLEVEL9K_CHANGESET_HASH_LENGTH` to any value you want. -By setting `POWERLEVEL9K_SHOW_BRANCH_ICON` it shows a nice icon before the -branch name. -Example: # enable the vcs segment in general POWERLEVEL9K_SHOW_CHANGESET=true # just show the 6 first characters of changeset POWERLEVEL9K_CHANGESET_HASH_LENGTH=6 + +You can also enable an additional branch icon in your prompt by setting +`POWERLEVEL9K_SHOW_BRANCH_ICON` to `true`: + # Show an icon before the branch name POWERLEVEL9K_SHOW_BRANCH_ICON=true -- cgit v1.2.3 From 0226f871f698d0d802f7a9dee9587d88a627856c Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Fri, 10 Jul 2015 00:43:10 +0200 Subject: Fix the branch icon and whitespaces in the vcs segment. --- README.md | 8 ++++---- powerlevel9k.zsh-theme | 26 +++++++++++++------------- 2 files changed, 17 insertions(+), 17 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7d5a5f76..6d7618d8 100644 --- a/README.md +++ b/README.md @@ -288,11 +288,11 @@ set `POWERLEVEL9K_CHANGESET_HASH_LENGTH` to any value you want. # just show the 6 first characters of changeset POWERLEVEL9K_CHANGESET_HASH_LENGTH=6 -You can also enable an additional branch icon in your prompt by setting -`POWERLEVEL9K_SHOW_BRANCH_ICON` to `true`: +You can also disable the branch icon in your prompt by setting +`POWERLEVEL9K_HIDE_BRANCH_ICON` to `true`: - # Show an icon before the branch name - POWERLEVEL9K_SHOW_BRANCH_ICON=true + # Hide the branch icon + POWERLEVEL9K_HIDE_BRANCH_ICON=true ##### Symbols diff --git a/powerlevel9k.zsh-theme b/powerlevel9k.zsh-theme index 83d7314c..84f74cfd 100644 --- a/powerlevel9k.zsh-theme +++ b/powerlevel9k.zsh-theme @@ -75,10 +75,10 @@ case $POWERLEVEL9K_MODE in VCS_TAG_ICON="\uE817 " #  VCS_BOOKMARK_ICON="\uE87B" #  VCS_COMMIT_ICON="\uE821 " #  - VCS_BRANCH_ICON=" \uE220" #  + VCS_BRANCH_ICON="\uE220" #  VCS_REMOTE_BRANCH_ICON="\uE804" #  - VCS_GIT_ICON="\uE20E " #  - VCS_HG_ICON="\uE1C3 " #  + VCS_GIT_ICON="\uE20E " #  + VCS_HG_ICON="\uE1C3 " #  ;; 'compatible') LEFT_SEGMENT_SEPARATOR="\u2B80" # ⮀ @@ -131,10 +131,10 @@ case $POWERLEVEL9K_MODE in VCS_TAG_ICON="\uE817 " #  VCS_BOOKMARK_ICON="\uE87B" #  VCS_COMMIT_ICON="\uE821 " #  - VCS_BRANCH_ICON=" \uE220" #  + VCS_BRANCH_ICON="\uE220" #  VCS_REMOTE_BRANCH_ICON="\uE804" #  - VCS_GIT_ICON="\uE20E " #  - VCS_HG_ICON="\uE1C3 " #  + VCS_GIT_ICON="\uE20E " #  + VCS_HG_ICON="\uE1C3 " #  ;; *) # Powerline-Patched Font required! @@ -158,14 +158,14 @@ case $POWERLEVEL9K_MODE in VCS_TAG_ICON='' VCS_BOOKMARK_ICON="\u263F" # ☿ VCS_COMMIT_ICON='' - VCS_BRANCH_ICON='@' + VCS_BRANCH_ICON="\uE0A0 " #  VCS_REMOTE_BRANCH_ICON="\u2192" # → - VCS_GIT_ICON="\uE0A0" #  - VCS_HG_ICON="\uE0A0" #  + VCS_GIT_ICON="" + VCS_HG_ICON="" ;; esac -if [[ "$POWERLEVEL9K_SHOW_BRANCH_ICON" != true ]]; then +if [[ "$POWERLEVEL9K_HIDE_BRANCH_ICON" == true ]]; then VCS_BRANCH_ICON='' fi @@ -210,15 +210,15 @@ if [[ "$POWERLEVEL9K_SHOW_CHANGESET" == true ]]; then VCS_CHANGESET_HASH_LENGTH="$POWERLEVEL9K_CHANGESET_HASH_LENGTH" fi - VCS_CHANGESET_PREFIX="%F{$VCS_FOREGROUND_COLOR_DARK}$VCS_COMMIT_ICON%0.$VCS_CHANGESET_HASH_LENGTH""i%f" + VCS_CHANGESET_PREFIX="%F{$VCS_FOREGROUND_COLOR_DARK}$VCS_COMMIT_ICON%0.$VCS_CHANGESET_HASH_LENGTH""i%f " fi zstyle ':vcs_info:*' enable git hg zstyle ':vcs_info:*' check-for-changes true VCS_DEFAULT_FORMAT="$VCS_CHANGESET_PREFIX%F{$VCS_FOREGROUND_COLOR}%b%c%u%m%f" -zstyle ':vcs_info:git:*' formats "%F{$VCS_FOREGROUND_COLOR}$VCS_GIT_ICON%f $VCS_DEFAULT_FORMAT" -zstyle ':vcs_info:hg:*' formats "%F{$VCS_FOREGROUND_COLOR}$VCS_HG_ICON%f $VCS_DEFAULT_FORMAT" +zstyle ':vcs_info:git:*' formats "%F{$VCS_FOREGROUND_COLOR}$VCS_GIT_ICON%f$VCS_DEFAULT_FORMAT" +zstyle ':vcs_info:hg:*' formats "%F{$VCS_FOREGROUND_COLOR}$VCS_HG_ICON%f$VCS_DEFAULT_FORMAT" zstyle ':vcs_info:*' actionformats " %b %F{red}| %a%f" -- cgit v1.2.3 From 3a857c276d28503d293634b0a1d1ce1eb3b15ff0 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Fri, 10 Jul 2015 20:39:27 -0700 Subject: README: Moving Dev Guide to Github wiki --- README.md | 59 ++++++----------------------------------------------------- 1 file changed, 6 insertions(+), 53 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ff124b2e..0f3867b2 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,7 @@ like with a normal installation and default settings: - [Gaps Between Segments](#gaps-between-segments) - [Meta](#meta) - [Kudos](#kudos) + - [Developing](#developing) - [Contributions / Bugs / Contact](#contributions--bugs--contact) @@ -414,6 +415,11 @@ This theme wouldn't have happened without inspiration from the original [agnoste Before creating this theme, I also tried [jeremyFreeAgent's theme](https://github.com/jeremyFreeAgent/oh-my-zsh-powerline-theme) and [maverick2000's theme, ZSH2000](https://github.com/maverick2000/zsh2000). +#### Developing + +Documentation for developers is kept on the [Powerlevel9k Github +wiki](https://github.com/bhilburn/powerlevel9k/wiki/Developers'-Guide). + #### Contributions / Bugs / Contact If you have any requests or bug reports, please use the tracker in this Github @@ -423,56 +429,3 @@ I'm happy to accept code contributions from anyone who has a bug fix, new featur If you would like to contact me directly, you can find my e-mail address on my [Github profile page](https://github.com/bhilburn). - -#### Developers Guide - -The theme has grown a lot lately, so I think a little explanation would be -helpful. - -##### Basic Knowledge - -Our main entry point are the `PROMPT` and `RPROMPT` variables, which are -interpreted by zsh itself. All that this (and any other) theme does is -filling these two variables with control instructions (like defining -colors, etc.) and ready-to-use data. So within this theme we collect a -whole bunch of information to put in that variables. You can find -`PROMPT` and `RPROMPT` at the very end of the `powerlevel9k.zsh-theme`. - -This simple diagram may explain the invoking order better: - -``` -+-----+ +---------+ -| Zsh |--->| $PROMPT | -+-----+ +---------+ - | - V - +---------------------+ +------------+ +---------------------+ - | build_left_prompt() |--->| prompt_*() |->| $1_prompt_segment() | - +---------------------+ +------------+ +---------------------+ -``` - -##### Adding Segments - -Feel free to add your own segments. Every segment gets called with an -orientation as first parameter (`left` or `right`), so we can figure -out on which side we should draw the segment. This information is -used at the time we call the actual segment-drawing function: -`$1_prompt_segment`. To make the magic color-overwrite mechanism to -work, we have to pass our function name as first argument. Usually -this is just `$0`. Second parameter is a default background color, -third the default foreground color. And finally we pass our content -to the function. So our function could look somewhat like this: - -```zsh - prompt_echo() { - local content='Hello World!' - $1_prompt_segment $0 blue red $content - } -``` - -At this point we can overwrite our blue-on-red segment by putting - - POWERLEVEL9K_ECHO_FOREGROUND="200" - POWERLEVEL9K_ECHO_BACKGROUND="040" - -in our `~/.zshrc`. We now have a pink-on-green segment. Yay! -- cgit v1.2.3 From 79499dbb00147fea47a66492b46c110445371c91 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Fri, 10 Jul 2015 20:43:06 -0700 Subject: README: Fixing symbol table headers --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index cba403aa..ebf643b9 100644 --- a/README.md +++ b/README.md @@ -301,7 +301,7 @@ The `vcs` segment uses various symbols to tell you the state of your repository. These symbols depend on your installed font and selected `POWERLEVEL9K_MODE` from the [Installation](#Installation) section above. -| `Bare Bones` | `Normal` | `Über` | explanation +| `Compatible` | `Powerline` | `Awesome Powerline` | Explanation |--------------|---------------------|-------------------|-------------------------- | `↑4` | `↑4` | ![icon_outgoing](https://cloud.githubusercontent.com/assets/1544760/7976089/b5904d6e-0a76-11e5-8147-5e873ac52d79.gif)4 | Number of commits your repository is ahead of your remote branch | `↓5` | `↓5` | ![icon_incoming](https://cloud.githubusercontent.com/assets/1544760/7976091/b5909c9c-0a76-11e5-9cad-9bf0a28a897c.gif)5 | Number of commits your repository is behind of your remote branch -- cgit v1.2.3 From 83584894703039a4337b1f7d7b969992ea4cb9c9 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Sun, 12 Jul 2015 18:10:33 -0700 Subject: README: Updating with minor fixes. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 42c6c9a0..e38b04b4 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ like with a normal installation and default settings: - [Segment Customization](#segment-customization) - [The AWS Profile Segment](#the-aws-profile-segment) - [The 'context' Segment](#the-context-segment) + - [The 'dir' segment](#the-dir-segment) - [The 'time' segment](#the-time-segment) - [Unit Test Ratios](#unit-test-ratios) - [The 'vcs' Segment](#the-vcs-segment) @@ -260,7 +261,7 @@ elements (it is by default), and define a `DEFAULT_USER` in your `~/.zshrc`: export DEFAULT_USER= -#### The `dir` segment +#### The 'dir' segment The `dir` segment shows the current working directory. You can limit the output to a certain length: @@ -427,7 +428,7 @@ Before creating this theme, I also tried [jeremyFreeAgent's theme](https://githu #### Developing Documentation for developers is kept on the [Powerlevel9k Github -wiki](https://github.com/bhilburn/powerlevel9k/wiki/Developers'-Guide). +wiki](https://github.com/bhilburn/powerlevel9k/wiki/Developer's-Guide). #### Contributions / Bugs / Contact -- cgit v1.2.3 From eed0c842735d8fe40e024dfd05ac09824f4fc6b2 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Sun, 19 Jul 2015 14:32:13 +0200 Subject: Made the `context` segment customizable. --- README.md | 8 +++++++- powerlevel9k.zsh-theme | 7 ++++++- 2 files changed, 13 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e38b04b4..53c8f482 100644 --- a/README.md +++ b/README.md @@ -366,7 +366,13 @@ of the `time` segment, you would use: Use the segment names from the above section `Segment Customization`. Some of the Segments have special color variables, as they change the colors according -to some internal rules. These Segments are `vcs`, `rspec_stats`, `symfony2_tests`: +to some internal rules. These Segments are `context`, `vcs`, `rspec_stats`, `symfony2_tests`: + + # Colors for root and other users: + POWERLEVEL9K_CONTEXT_DEFAULT_BACKGROUND="green" + POWERLEVEL9K_CONTEXT_DEFAULT_FOREGROUND="cyan" + POWERLEVEL9K_CONTEXT_ROOT_BACKGROUND="red" + POWERLEVEL9K_CONTEXT_ROOT_FOREGROUND="blue" # General VCS color segments: POWERLEVEL9K_VCS_FOREGROUND='blue' diff --git a/powerlevel9k.zsh-theme b/powerlevel9k.zsh-theme index 4f75e89b..8677ac4a 100644 --- a/powerlevel9k.zsh-theme +++ b/powerlevel9k.zsh-theme @@ -437,7 +437,12 @@ prompt_aws() { # Note that if $DEFAULT_USER is not set, this prompt segment will always print prompt_context() { if [[ "$USER" != "$DEFAULT_USER" || -n "$SSH_CLIENT" ]]; then - $1_prompt_segment "$0" "$DEFAULT_COLOR" "011" "%(!.%{%F{yellow}%}.)$USER@%m" + if [[ $(print -P "%#") == '#' ]]; then + # Shell runs as root + $1_prompt_segment "$0_ROOT" "$DEFAULT_COLOR" "yellow" "$USER@%m" + else + $1_prompt_segment "$0_DEFAULT" "$DEFAULT_COLOR" "011" "$USER@%m" + fi fi } -- cgit v1.2.3 From cb20e0e0d95227c7dfa44392527e123fe5527f53 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Sun, 19 Jul 2015 14:57:17 +0200 Subject: Made Multiline-Icons customizable. --- README.md | 5 +++++ powerlevel9k.zsh-theme | 7 +++++-- 2 files changed, 10 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e38b04b4..54b19833 100644 --- a/README.md +++ b/README.md @@ -343,6 +343,11 @@ Here is what it looks like: ![](http://bhilburn.org/content/images/2015/03/double-line.png) +If you want other icons, you can set the following variables in your `~/.zshrc`: + + POWERLEVEL9K_MULTILINE_FIRST_PROMPT_PREFIX="↱" + POWERLEVEL9K_MULTILINE_SECOND_PROMPT_PREFIX="↳ " + #### Light Color Theme If you prefer to use "light" colors, simply set `POWERLEVEL9K_COLOR_SCHEME` diff --git a/powerlevel9k.zsh-theme b/powerlevel9k.zsh-theme index 4f75e89b..a9105482 100644 --- a/powerlevel9k.zsh-theme +++ b/powerlevel9k.zsh-theme @@ -622,8 +622,11 @@ powerlevel9k_init() { add-zsh-hook precmd vcs_info if [[ "$POWERLEVEL9K_PROMPT_ON_NEWLINE" == true ]]; then - PROMPT="╭─%{%f%b%k%}"'$(build_left_prompt)'" -╰─ " + [[ -n $POWERLEVEL9K_MULTILINE_FIRST_PROMPT_PREFIX ]] || POWERLEVEL9K_MULTILINE_FIRST_PROMPT_PREFIX="╭─" + [[ -n $POWERLEVEL9K_MULTILINE_SECOND_PROMPT_PREFIX ]] || POWERLEVEL9K_MULTILINE_SECOND_PROMPT_PREFIX="╰─ " + + PROMPT="$POWERLEVEL9K_MULTILINE_FIRST_PROMPT_PREFIX%{%f%b%k%}"'$(build_left_prompt)'" +$POWERLEVEL9K_MULTILINE_SECOND_PROMPT_PREFIX" # The right prompt should be on the same line as the first line of the left # prompt. To do so, there is just a quite ugly workaround: Before zsh draws # the RPROMPT, we advise it, to go one line up. At the end of RPROMPT, we -- cgit v1.2.3 From d17fecbf81ddfc8fad682d3843b069a43dfa1c7b Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Sun, 19 Jul 2015 12:20:04 -0700 Subject: README: bit of cleanup in color customization docs --- README.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 53c8f482..62a24814 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,8 @@ like with a normal installation and default settings: - [Styling](#styling) - [Double-Lined Prompt](#double-lined-prompt) - [Light Color Theme](#light-color-theme) - - [Further color customizations](#further-color-customizations) + - [Segment Color Customization](#segment-color-customization) + - [Special Segment Colors](#special-segment-colors) - [Troubleshooting](#troubleshooting) - [Gaps Between Segments](#gaps-between-segments) - [Meta](#meta) @@ -355,26 +356,36 @@ Light'](https://github.com/altercation/solarized) users. Check it out: ![](http://bhilburn.org/content/images/2015/03/solarized-light.png) -#### Further color customizations +#### Segment Color Customization For each segment in your prompt, you can specify a foreground and background -color by setting them in your `~/.zshrc`. For example, to change the appearance -of the `time` segment, you would use: +color by setting them in your `~/.zshrc`. Use the segment names from the above +section `Segment Customization`. For example, to change the appearance of the +`time` segment, you would use: POWERLEVEL9K_TIME_FOREGROUND='red' POWERLEVEL9K_TIME_BACKGROUND='blue' -Use the segment names from the above section `Segment Customization`. Some of -the Segments have special color variables, as they change the colors according -to some internal rules. These Segments are `context`, `vcs`, `rspec_stats`, `symfony2_tests`: +Note that you can also use a colorcode value. Example: - # Colors for root and other users: + POWERLEVEL9K_VCS_FOREGROUND='021' # Dark blue + +For a full list of supported colors, run the `spectrum_ls` program in your +terminal. + +#### Special Segment Colors + +Some segments have additional color options if you want to customize the look of +your prompt even further. These Segments are `context`, `vcs`, `rspec_stats`, +`symfony2_tests`: + + # Customizing `context` colors for root and non-root users POWERLEVEL9K_CONTEXT_DEFAULT_BACKGROUND="green" POWERLEVEL9K_CONTEXT_DEFAULT_FOREGROUND="cyan" POWERLEVEL9K_CONTEXT_ROOT_BACKGROUND="red" POWERLEVEL9K_CONTEXT_ROOT_FOREGROUND="blue" - # General VCS color segments: + # Advanced `vcs` color customization POWERLEVEL9K_VCS_FOREGROUND='blue' POWERLEVEL9K_VCS_DARK_FOREGROUND='black' POWERLEVEL9K_VCS_BACKGROUND='green' @@ -402,13 +413,6 @@ to some internal rules. These Segments are `context`, `vcs`, `rspec_stats`, `sym POWERLEVEL9K_SYMFONY2_TESTS_BAD_FOREGROUND='red' POWERLEVEL9K_SYMFONY2_TESTS_BAD_BACKGROUND='white' -You could also use a colorcode value. Example: - - POWERLEVEL9K_VCS_FOREGROUND='021' # Dark blue - -For a full list of supported colors, run the `spectrum_ls` program in your -terminal. - ### Troubleshooting Here are some fixes to some common problems. -- cgit v1.2.3 From ea2af79042044e1f05a65f161259b32ad4b1b3c4 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Sun, 19 Jul 2015 12:24:21 -0700 Subject: README: simple cleanup --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a0a3035f..5225c16a 100644 --- a/README.md +++ b/README.md @@ -344,7 +344,8 @@ Here is what it looks like: ![](http://bhilburn.org/content/images/2015/03/double-line.png) -If you want other icons, you can set the following variables in your `~/.zshrc`: +You can customize the icons used to draw the multiline prompt by setting the +following variables in your `~/.zshrc`: POWERLEVEL9K_MULTILINE_FIRST_PROMPT_PREFIX="↱" POWERLEVEL9K_MULTILINE_SECOND_PROMPT_PREFIX="↳ " @@ -436,9 +437,12 @@ terminal emulator (e.g., 'terminator', 'gnome-terminal', 'konsole', etc.,). #### Kudos -This theme wouldn't have happened without inspiration from the original [agnoster](https://gist.github.com/agnoster/3712874) Oh-My-ZSH theme. +This theme wouldn't have happened without inspiration from the original +[agnoster](https://gist.github.com/agnoster/3712874) Oh-My-ZSH theme. -Before creating this theme, I also tried [jeremyFreeAgent's theme](https://github.com/jeremyFreeAgent/oh-my-zsh-powerline-theme) and [maverick2000's theme, ZSH2000](https://github.com/maverick2000/zsh2000). +Before creating this theme, I also tried [jeremyFreeAgent's +theme](https://github.com/jeremyFreeAgent/oh-my-zsh-powerline-theme) and +[maverick2000's theme, ZSH2000](https://github.com/maverick2000/zsh2000). #### Developing @@ -450,7 +454,9 @@ wiki](https://github.com/bhilburn/powerlevel9k/wiki/Developer's-Guide). If you have any requests or bug reports, please use the tracker in this Github repository. -I'm happy to accept code contributions from anyone who has a bug fix, new feature, or just a general improvement! Please submit your contribution as a Github pull-request. +I'm happy to accept code contributions from anyone who has a bug fix, new +feature, or just a general improvement! Please submit your contribution as +a Github pull-request. If you would like to contact me directly, you can find my e-mail address on my [Github profile page](https://github.com/bhilburn). -- cgit v1.2.3 From 71f5be368ed4c5854a40895dd4590af9759af173 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Sun, 19 Jul 2015 12:40:59 -0700 Subject: README: Updating introduction to the theme. --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5225c16a..aa6be3a5 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,24 @@ ## powerlevel9k Theme for ZSH Powerlevel9k is a theme for ZSH which uses [Powerline -Fonts](https://github.com/Lokaltog/powerline-fonts), thus giving you the most -epic terminal styling in the universe. - -Look like a bad-ass. Impress everyone in 'Screenshot Your Desktop' threads. Use powerlevel9k. - -Powerlevel9k can be used with vanilla ZSH, -[Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh), or +Fonts](https://github.com/Lokaltog/powerline-fonts). It can be used with vanilla +ZSH, [Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh), or [Prezto](https://github.com/sorin-ionescu/prezto), and can also be installed using [antigen](https://github.com/zsh-users/antigen). - -In addition to looking amazing, this theme actually provides a lot of useful -information in configurable prompt segments. Here is an example of what it looks -like with a normal installation and default settings: +Look like a bad-ass. Impress everyone in 'Screenshot Your Desktop' threads. Use powerlevel9k. ![](http://bhilburn.org/content/images/2015/01/pl9k-improved.png) +There are a number of Powerline ZSH themes available, now. The developers of +this theme focus on three primary goals: +1. Give users a great out-of-the-box configuration with no additional + configuration required. +2. Make customization easy for users who do want to tweak their prompt. +3. Provide useful segments that you can enable to make your prompt even more + effective and helpful. We have prompt segments for everything from unit test + coverage to your AWS instance. + **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* -- cgit v1.2.3 From c853be57e7efa79f9818394e3aec7900a6a35516 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Sun, 19 Jul 2015 12:42:00 -0700 Subject: README: markdown syntax derp --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index aa6be3a5..71dfceb2 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Look like a bad-ass. Impress everyone in 'Screenshot Your Desktop' threads. Use There are a number of Powerline ZSH themes available, now. The developers of this theme focus on three primary goals: + 1. Give users a great out-of-the-box configuration with no additional configuration required. 2. Make customization easy for users who do want to tweak their prompt. -- cgit v1.2.3