From 153db77f332434098249bbf207e909d4fdbf3ff4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Romey?= Date: Sun, 4 Nov 2012 15:06:02 +0100 Subject: [PATCH] Better help --- README.md | 18 +++++++++--------- install_in_omz.sh | 30 +++++++++++++++++++++++++++++- 2 files changed, 38 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f7aef67..5aa27dc 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,13 @@ Set Up 1. Clone the repository. -2. Create un symlink of **powerline.zsh-theme** in **.oh-my-zsh/themes/**. You can use the **install_in_omz.sh** file : +2. Create un symlink of **powerline.zsh-theme** in **.oh-my-zsh/themes/**. You can use the **install_in_omz.sh** file: ``` ./install_in_omz.sh ``` -3. Configure the theme in your **.zshrc** file : +3. Configure the theme in your **.zshrc** file: ``` ZSH_THEME="powerline" @@ -31,32 +31,32 @@ More options All options must be overridden in your **.zshrc** file. By default, at the right of the powerline are displayed the date and the time. -If you don't want date or time, you can choose what you want to display : +If you don't want date or time, you can choose what you want to display: ``` POWERLINE_RIGHT_A="date replacement" POWERLINE_RIGHT_B="time replacement" ``` -If you don't want the blank line before the prompt : +If you don't want the blank line before the prompt: ``` POWERLINE_NO_BLANK_LINE="true" ``` -If you want full path : +If you want full path: ``` POWERLINE_FULL_CURRENT_PATH="true" ``` -If you want git info on right instead of left : +If you want git info on right instead of left: ``` POWERLINE_SHOW_GIT_ON_RIGHT="true" ``` -If you want to tell if you are in a remote SSH session : +If you want to tell if you are in a remote SSH session: ``` POWERLINE_DETECT_SSH="true" @@ -65,8 +65,8 @@ POWERLINE_DETECT_SSH="true" Requirements ------------ -* Vim Powerline patched font : See [Powerline for vim](https://github.com/Lokaltog/vim-powerline.git) for more info. -* Z shell (zsh) : See [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) for more info. +* Vim Powerline patched font: See [Powerline for vim](https://github.com/Lokaltog/vim-powerline.git) for more info. +* Z shell (zsh): See [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) for more info. Contribute ---------- diff --git a/install_in_omz.sh b/install_in_omz.sh index 697f644..5a31398 100755 --- a/install_in_omz.sh +++ b/install_in_omz.sh @@ -4,5 +4,33 @@ echo "Creating symlink from here to your oh-my-zsh themes path..." ln -f powerline.zsh-theme ~/.oh-my-zsh/themes/powerline.zsh-theme -echo "Done ! (the symlink is ~/.oh-my-zsh/themes/powerline.zsh-theme)" +echo " +Done ! (the symlink is ~/.oh-my-zsh/themes/powerline.zsh-theme) +----------------------------------------------------------------- + +Options: +All options must be overridden in your .zshrc file. + +By default, at the right of the powerline are displayed the date and the time. If you don't want date or time, you can choose what you want to display: + +POWERLINE_RIGHT_A=\"date replacement\" +POWERLINE_RIGHT_B=\"time replacement\" +If you don't want the blank line before the prompt: + +POWERLINE_NO_BLANK_LINE=\"true\" +If you want full path: + +POWERLINE_FULL_CURRENT_PATH=\"true\" +If you want git info on right instead of left: + +POWERLINE_SHOW_GIT_ON_RIGHT=\"true\" +If you want to tell if you are in a remote SSH session: + +POWERLINE_DETECT_SSH=\"true\" + +---------------------------------------------------------------- + +Requirements: +Vim Powerline patched font: See Powerline for vim for more info. +Z shell (zsh): See oh-my-zsh for more info."