From 10ab5e2b58f5c7cff41c18279016d9e963b70287 Mon Sep 17 00:00:00 2001 From: Colin Hebert Date: Sat, 14 Apr 2012 11:48:55 +0100 Subject: [PATCH] [Fix #111] Add documentation for prompt --- modules/prompt/README.md | 23 +++++++++++++++++++++++ modules/prompt/init.zsh | 7 ------- 2 files changed, 23 insertions(+), 7 deletions(-) create mode 100644 modules/prompt/README.md diff --git a/modules/prompt/README.md b/modules/prompt/README.md new file mode 100644 index 00000000..98c82988 --- /dev/null +++ b/modules/prompt/README.md @@ -0,0 +1,23 @@ +Prompt +====== + +Loads prompt [themes][1]. + +Settings +-------- + +To select a prompt theme, add the following to *zshrc*, and replace **name** with the +name of the theme you wish to load. Setting it to **random** will load a random +theme. + + zstyle ':omz:module:prompt' theme 'name' + +Authors +------- + +*The authors of this module should be contacted via the GitHub issue tracker.* + + - [Sorin Ionescu](/sorin-ionescu) + +[1]: http://zsh.sourceforge.net/Doc/Release/User-Contributions.html#Prompt-Themes + diff --git a/modules/prompt/init.zsh b/modules/prompt/init.zsh index 185c71d8..973dd711 100644 --- a/modules/prompt/init.zsh +++ b/modules/prompt/init.zsh @@ -4,13 +4,6 @@ # Authors: # Sorin Ionescu # -# Usage: -# To select a prompt theme, add the following to zshrc, and replace 'name' -# with the name of the theme you wish to load. Setting it to random will load -# a random theme. -# -# zstyle ':omz:module:prompt' theme 'name' -# # Load and run the prompt theming system. autoload -Uz promptinit && promptinit