fresh install

[dotfiles.git] / README.md

diff --git a/README.md b/README.md
index dc2e95a..8ebd1a7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,17 @@
-Yay dotfiles to share
-=====================
+# Dotfiles.
 
-Also includes a script to install it:)
+## True dotfiles
+Tip: use GNU stow
 
-Todo:
-add mutt, offlineimap, msmtp, Xresources, i3
+`stow -t ~/ DIR`
+
+## 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/`
+- `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`