From 02c492176aa1f16a838f60f48349cacb6d3bea91 Mon Sep 17 00:00:00 2001 From: David Runge Date: Sun, 8 May 2016 18:42:05 +0200 Subject: README.rst: Adding README.rst for installation and requirements. --- README.rst | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..ff5de0f --- /dev/null +++ b/README.rst @@ -0,0 +1,65 @@ +dotfiles +======== + +| dotfiles is a repository, that should go into the user's $HOME. +| It features configurations for zsh and many others. + +Requirements +------------ +Some requirements have to be met to make things work smoothly. +As I'm using |arch_linux|, all links are Arch specific. + +zsh +*** +I make extensive use of |zsh| whenever I can. The following plugins/extensions are needed for this repository to work. + +* |zsh-syntax-highlighting| (|aur|) +* |zsh-completions| +* |zsh-history-substring-search-git| (|aur|) + +autorandr +********* +For the screen setup scripts to work |autorandr| is needed. + +Installation +------------ +If the $HOME is that of a freh install, one can simple init an empty repository and set its remote to the correct path: + + .. code:: bash + + git init + # readonly link + git remote add origin git://sleepmap.de/config/dotfiles + # read/write link + git remote add origin git@sleepmap.de:config/dotfiles + git fetch + git checkout -t origin/master + + +.. |autorandr| raw:: html + + autorandr + +.. |zsh| raw:: html + + zsh + +.. |zsh-completions| raw:: html + + zsh-completions + +.. |zsh-syntax-highlighting| raw:: html + + zsh-syntax-highlighting + +.. |zsh-history-substring-search-git| raw:: html + + zsh-history-substring-search + +.. |aur| raw:: html + + AUR + +.. |arch_linux| raw:: html + + Arch Linux -- cgit v1.2.3-70-g09d2