zshrc/README.md

40 lines
1.2 KiB
Markdown

<dl>
<dt>Author</dt>
<dd>Sebastian Tramp [mail@sebastian.tramp.name](mail@sebastian.tramp.name)</dd>
<dt>License</dt>
<dd>http://opensource.org/licenses/gpl-license.php</dd>
</dl>
Due to many requests I share my zsh configuration compilation.
Copy the repository to ~/.zsh and run 'make install' once
(or link the ~/.config/zsh/zshrc manually to ~/.zshrc)
File description
================
<dl>
<dt>`$ZSH_CONFIG/README`</dt>
<dd>This file</dd>
<dt>`$ZSH_CONFIG/Makefile`</dt>
<dd>make-config to run with 'make install'</dd>
<dt>`$ZSH_CONFIG/aliases`</dt>
<dd>alias definitions which can be edited/modified with 'aedit'</dd>
<dt>`$ZSH_CONFIG/completion`</dt>
<dd>tab completion configuration</dd>
<dt>`$ZSH_CONFIG/functions`</dt>
<dd>functions and key bindings to that functions</dd>
<dt>`$ZSH_CONFIG/options`</dt>
<dd>shell options as history size, general keyindings, etc</dd>
<dt>`$ZSH_CONFIG/prompt`</dt>
<dd>the prompt definition</dd>
<dt>`$ZSH_CONFIG/zshrc`</dt>
<dd>the main RC file (will be linked to ~/.zshrc)</dd>
</dl>
These files are not in the repository but will be created
<dl>
<dt>`$ZSH_CACHE/history`</dt>
<dd>the history file (shared for all zsh instances)</dd>
</dl>