README.md: formatting def lists

master
Denis Knauf 2013-07-09 16:03:41 +02:00
parent 8246965819
commit e48ad85dd4
1 changed files with 26 additions and 20 deletions

View File

@ -1,7 +1,9 @@
Author
: Sebastian Tramp <mail@sebastian.tramp.name>
License
: http://opensource.org/licenses/gpl-license.php
<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
@ -10,23 +12,27 @@ Copy the repository to ~/.zsh and run 'make install' once
File description
================
`$ZSH_CONFIG/README`
: This file
`$ZSH_CONFIG/Makefile`
: make-config to run with 'make install'
`$ZSH_CONFIG/aliases`
: alias definitions which can be edited/modified with 'aedit'
`$ZSH_CONFIG/completion`
: tab completion configuration
`$ZSH_CONFIG/functions`
: functions and key bindings to that functions
`$ZSH_CONFIG/options`
: shell options as history size, general keyindings, etc
`$ZSH_CONFIG/prompt`
: the prompt definition
`$ZSH_CONFIG/zshrc`
: the main RC file (will be linked to ~/.zshrc)
<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>
`$ZSH_CACHE/history - the history file (shared for all zsh instances)
</dl>