jonny/dotfiles
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Better readme

Browse source
This commit is contained in:
Jonny Barnes 2016-05-13 12:46:09 +01:00
parent d4b82d2bc9
commit 5ad500152c
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -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.