From 02c492176aa1f16a838f60f48349cacb6d3bea91 Mon Sep 17 00:00:00 2001
From: David Runge <dave@sleepmap.de>
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

(limited to '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
+
+  <a href="https://aur.archlinux.org/packages/autorandr-git" target="_blank">autorandr</a>
+
+.. |zsh| raw:: html
+
+  <a href="https://www.archlinux.org/packages/extra/x86_64/zsh/" target="_blank">zsh</a>
+
+.. |zsh-completions| raw:: html
+
+  <a href="https://www.archlinux.org/packages/community/any/zsh-completions/" target="_blank">zsh-completions</a>
+
+.. |zsh-syntax-highlighting| raw:: html
+
+  <a href="https://aur.archlinux.org/packages/zsh-syntax-highlighting-git/" target="_blank">zsh-syntax-highlighting</a>
+
+.. |zsh-history-substring-search-git| raw:: html
+
+  <a href="https://aur.archlinux.org/packages/zsh-history-substring-search-git/" target="_blank">zsh-history-substring-search</a>
+
+.. |aur| raw:: html
+
+  <a href="https://aur.archlinux.org/" target="_blank">AUR</a>
+
+.. |arch_linux| raw:: html
+
+  <a href="https://archlinux.org/" target="_blank">Arch Linux</a>
-- 
cgit v1.2.3-54-g00ecf