Browse Source

[Fix #111] Add documentation for prompt

master
Colin Hebert 13 years ago committed by Sorin Ionescu
parent
commit
10ab5e2b58
  1. 23
      modules/prompt/README.md
  2. 7
      modules/prompt/init.zsh

23
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

7
modules/prompt/init.zsh

@ -4,13 +4,6 @@
# Authors: # Authors:
# Sorin Ionescu <sorin.ionescu@gmail.com> # Sorin Ionescu <sorin.ionescu@gmail.com>
# #
# 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. # Load and run the prompt theming system.
autoload -Uz promptinit && promptinit autoload -Uz promptinit && promptinit

Loading…
Cancel
Save