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

Update the README for the repo

Browse source
This commit is contained in:
Jonny Barnes 2024-06-25 19:42:33 +01:00
parent 0998e2de8e
commit 4a9e42bd6a
Signed by: jonny
SSH key fingerprint: SHA256:CTuSlns5U7qlD9jqHvtnVmfYV3Zwl2Z7WnJ4/dqOaL8
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -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). [`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 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 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
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 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 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 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. First clone the repo.
As mentioned above my git credentials are stored in an untracked file: 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 # 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 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 ## Auto switch between light and dark mode