[Fix #111] Add documentation for prompt
This commit is contained in:
parent
399b2f529d
commit
10ab5e2b58
23
modules/prompt/README.md
Normal file
23
modules/prompt/README.md
Normal file
|
@ -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
|
||||
|
|
@ -4,13 +4,6 @@
|
|||
# Authors:
|
||||
# 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.
|
||||
autoload -Uz promptinit && promptinit
|
||||
|
|
Loading…
Reference in a new issue