X-Git-Url: https://git.martlubbers.net/?a=blobdiff_plain;f=README.md;h=5bfcd4222413eacbda0f6836f97a6a7909de419b;hb=d1938db557b3655581795e7070196409d087d5bd;hp=549c6b6db37a0c6f61ef171b6f6cf5a7047e965f;hpb=7df7ab410d3a07d88f42cb9a83752d11f3093001;p=dotfiles.git

diff --git a/README.md b/README.md
index 549c6b6..5bfcd42 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,19 @@
-Yay dotfiles to share
-=====================
+# Dotfiles.
 
-Also includes a script to install it:)
+## True dotfiles
+Tip: use GNU stow
 
-Containts:
-- vimrc
-- i3 config including custom bar and lock
-- Xresources with nice colorscheme and transparant terminals
-- bashrc
-- muttrc
+`stow -t ~/ DIR`
 
-Todo:
-add offlineimap, msmtp
+## Other configurations
+
+- `udev/backup.rules` defines the rules for the automatic backup.
+  Install in: `/etc/udev/rules.d`
+- `20-keyboard.conf` defines the keyboard layout.
+  Install in: `/etc/X11/xorg.conf.d/`
+- `dirs.sh` creates all the directories so that stow won't link entire
+  directories.
+- `pkgs.sh` installs all™ packages needed for the dotfiles
+- `config.h` contains `config.h`'s for `st` and `dwm`
+- `texlive.profile` contains a minimal texlive profile for unattended installation.
+  Install texlive by running `install-tl -profile texlive.profile`