X-Git-Url: https://ruderich.org/simon/gitweb/?p=config%2Fdotfiles.git;a=blobdiff_plain;f=README;h=d94ea97f715238bdcddd9fe2c63c9667e32e5044;hp=c9432c01e5063764e9b829500ea6c85354954802;hb=9e4b2aff9242c3e72c714c3bf01c670b576e6627;hpb=4768a6dc98f726190043198e76ea21916e40cd20

diff --git a/README b/README
index c9432c0..d94ea97 100644
--- a/README
+++ b/README
@@ -1,10 +1,11 @@
-# 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