From 4a9e42bd6a14395e98fbc6b0414e710092af879a Mon Sep 17 00:00:00 2001 From: Jonny Barnes Date: Tue, 25 Jun 2024 19:42:33 +0100 Subject: [PATCH] Update the README for the repo --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9ff291e..5adbb7c 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,7 @@ 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 +directory. There is one exception to this, the `.gitconfig` file. I don’t want actual commiter details committed into this repo. 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 @@ -17,7 +15,7 @@ be in a dirty state, permanently. 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: +`$HOME/.extra`. This must be manually created, mine looks something like: ``` # Git credentials @@ -30,7 +28,10 @@ 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. +`.zshrc`. + +> [!WARNING] +> This is a **destructive** process, so backup your dotfiles first. ## Auto switch between light and dark mode