X-Git-Url: https://git.martlubbers.net/?a=blobdiff_plain;f=README.md;h=5bfcd4222413eacbda0f6836f97a6a7909de419b;hb=7b466019e6be1e766c6dbe3f85a43b36c538b370;hp=58d88759aa80b641babd4e9aaebce36f76b174cd;hpb=336b6c6c69a03210ca9f666e82de17503a129045;p=dotfiles.git

diff --git a/README.md b/README.md
index 58d8875..5bfcd42 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,19 @@
-Yay dotfiles to share
-=====================
+# Dotfiles.
 
-Also includes a script to install it:)
+## True dotfiles
+Tip: use GNU stow
 
-notes:
-* For msmtp I've patched my msmtp to have the --password flag included using the patch found at https://aur.archlinux.org/packages/msmtp-pwpatched/
-* In bashrc there are two functions concerning encrypted cloud storage, for more info: http://martlubbers.net/nsa-dropbox.html
+`stow -t ~/ DIR`
 
-TODO:
-* screen, irssi
+## 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`