From 5ad500152c5e0f1fbf6477ae7ca87df1adb63724 Mon Sep 17 00:00:00 2001 From: Jonny Barnes Date: Fri, 13 May 2016 12:46:09 +0100 Subject: [PATCH] Better readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e98ce4b..6091a7e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ # dotfiles -My dotfiles + +Here’s my dotfiles, inspired by people like Mathias. See his dotfiles at +`[https://github.com/mathias/dotfiles](https://github.com/mathias/dotfiles)`. + +The idea I’m currently going down is to create a symlink from `$HOME` to this +directory. There is one exception to this, the `.gitconfig` file. This derives +from not wanting anyone to accidentally commiting as me to git, that would +however require people to use this repo, unlikely. So my git credentials are +stored in a `.extra` file which gets sourced. This then calls the relavent git +command, which causes git to edit `$HOME/.gitconfig`. If that file was a symlink +to this repo, then the repo would see the file as edited and the repo would then +be in a dirty state, permanently. + +## Usage + +First clone the repo. Then run `./boostrap.sh`, this will create all the +necessary symlinks. This is a *destructive* process, so backup your dotfiles +first.