diff --git a/README.md b/README.md index e8dfe35..ac54a51 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,20 @@ 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. +First clone the repo. + +As mentioned above my git credentials are stored in an untracked file: +`$HOME/.extra`. This must be manually created, mine looks like: + +``` +# Git credentials +GIT_AUTHOR_NAME="Jonny Barnes" +GIT_COMMITER_NAME="$GIT_AUTHOR_NAME" +git config --global user.name "$GIT_AUTHOR_NAME" +GIT_AUTHOR_EMAIL="jonny@jonnybarnes.uk" +GIT_COMMITER_EMAIL="$GIT_AUTHOR_EMAIL" +git config --global user.email "$GIT_AUTHOR_EMAIL" +``` + +Run `./boostrap.sh`, this will create all the necessary symlinks, then source +`.zshrc`. This is a **destructive** process, so backup your dotfiles first.