From 96cd3d4b6a665943411b3541dce7c32cfebb7e50 Mon Sep 17 00:00:00 2001 From: Jonny Barnes Date: Fri, 13 May 2016 13:00:05 +0100 Subject: [PATCH] Mention need to create ~/.extra --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) 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.