README

[dotfiles] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..4537283
--- /dev/null
+++ b/README.md
@@ -0,0 +1,119 @@
+# dotfiles
+
+This is a set of configuration files for a bunch of Unix apps I use regularly.
+
+## Basic setup
+
+```
+git clone http://delx.net.au/git/dotfiles .dotfiles
+```
+
+
+Make a backup of any existing files:
+```
+cd
+mkdir -p backup
+mv .bash .bash_profile .bashrc .gitconfig .inputrc .pythonrc.py .screenrc .vim .vimrc backup/
+```
+
+
+Symlink the config files into your home directory:
+```
+ln -sf ~/.dotfiles/{.bash,.bash_profile,.bashrc,.gitconfig,.inputrc,.pythonrc.py,.screenrc,.vim,.vimrc} ~/
+ln -sf ~/.dotfiles/.gitignore_global ~/.gitignore
+ln -sf ~/.dotfiles/.ssh/config ~/.ssh/
+```
+
+
+Symlink the git hooks
+```
+cd ~/.dotfiles/.git/
+rm -rf hooks
+ln -s ../git-hooks hooks
+```
+
+
+## Emacs setup
+
+Symlink the emacs config:
+```
+ln -sf ~/.dotfiles/.emacs.d ~/
+```
+
+
+Initialise the emacs package submodules
+```
+cd ~/.dotfiles
+git submodule init
+git submodule update
+```
+
+
+Set up Emacs daemon to autostart:
+```
+mkdir -p ~/.config/autostart
+ln -sf ~/.dotfiles/.config/autostart/emacs.desktop ~/.config/autostart
+mkdir -p ~/.local/share/applications
+ln -sf ~/.dotfiles/.local/share/applications/emacs.desktop ~/.local/share/applications/
+```
+
+
+## xmonad setup
+
+Symlink the xmonad config:
+```
+mkdir -p ~/.xmonad
+ln -sf ~/.dotfiles/.xmonad/* ~/.xmonad/
+```
+
+
+Set up xmonad to autostart:
+```
+mkdir -p ~/.config/autostart
+ln -sf ~/.config/autostart/{xmonad.desktop,Kupfer.desktop} ~/.config/autostart
+```
+
+
+## XFCE setup
+
+```
+xfconf-query -n -t bool -c xfce4-session -p /startup/ssh-agent/enabled -s true
+xfconf-query -n -t string -c xfce4-session -p /startup/ssh-agent/type -s ssh-agent
+```
+
+
+## Font setup
+
+Symlink the font config:
+```
+mkdir -p ~/.config/fontconfig
+ln -s ~/.dotfiles/.config/fontconfig/fonts.conf ~/.config/fontconfig/
+```
+
+
+## Firefox setup
+
+Privacy:
+```
+privacy.donottrackheader.enabled = true
+privacy.trackingprotection.enabled = true
+```
+
+Make the URL bar more stupid:
+```
+browser.fixup.alternate.enabled = false
+browser.urlbar.trimURLs = false
+keyword.enabled = false
+```
+
+Blank home and new tab page:
+```
+browser.startup.homepage = about:blank
+browser.newtabpage.enabled = false
+browser.newtabpage.enhanced = false
+```
+
+Send DNS through SOCKS proxy:
+```
+network.proxy.socks_remote_dns = true
+```