-# README #
+README
+======
-Contains my configuration files. They are designed to work on all my computers
-with no changes.
+Git repository to store my configuration, designed to by cloned to
+`~/.config/dotfiles`. `~/.config` is not used to allow a separate directory
+hierarchy than just the program names which is custom for `~/.config`.
-There are multiple git repositories for each area like mail, shell, vcs, etc.
-This repository contains only data used by all of them.
+NOTE: This repository must contain only public data as it will be stored on
+many hosts!
-If the used program provides conditionals (like Vim or shells) they are used.
-Otherwise m4 and awk is used to generate adaptive files.
+// vim: ft=asciidoc