diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 63 |
1 files changed, 50 insertions, 13 deletions
@@ -9,6 +9,32 @@ Look like a bad-ass. Impress everyone in 'Screenshot Your Desktop' threads. Use In addition to looking amazing, this theme actually provides a lot of useful information in configurable prompt segments. +<!-- START doctoc generated TOC please keep comment here to allow auto update --> +<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> +**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) + +<!-- END doctoc generated TOC please keep comment here to allow auto update --> + ### Features * Supports `git` and `mercurial` repo information through ZSH's `VCS_INFO`: @@ -40,19 +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. - -#### 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. +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 Powerlevel9k @@ -159,6 +175,27 @@ 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 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: + + +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: + + +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 |