From 89f8c47d8191890bcefbddddb94d4d9995a1d1cb Mon Sep 17 00:00:00 2001 From: Sravan Balaji Date: Sat, 1 Aug 2020 23:16:19 -0400 Subject: [PATCH] README Updates - Update dotfiles README with instructions to install on new system - Add list of personal modifications to dwm, slock, and slstatus READMEs --- .config/dwm | 2 +- .config/slock | 2 +- .config/slstatus | 2 +- README.md | 29 +++++++++++++++++++++++++++++ 4 files changed, 32 insertions(+), 3 deletions(-) diff --git a/.config/dwm b/.config/dwm index 4460e3c..586dfc1 160000 --- a/.config/dwm +++ b/.config/dwm @@ -1 +1 @@ -Subproject commit 4460e3cc91e2d34d15f1787de84f4d804b6e8f3b +Subproject commit 586dfc1ddf00729eb6bb0acfe2cec1516587f9ba diff --git a/.config/slock b/.config/slock index 76df5be..44a8517 160000 --- a/.config/slock +++ b/.config/slock @@ -1 +1 @@ -Subproject commit 76df5beac41980d58811f844249e2af6f577114f +Subproject commit 44a8517dd5567cf6ab1966e6c6f7915cdb50d62f diff --git a/.config/slstatus b/.config/slstatus index a250d90..91c8d8a 160000 --- a/.config/slstatus +++ b/.config/slstatus @@ -1 +1 @@ -Subproject commit a250d90ce69db506824114408938dd91ffe21dd4 +Subproject commit 91c8d8a382ff9216a21af696bdf08bfd05905157 diff --git a/README.md b/README.md index 474d34a..dc4d7c9 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,35 @@ Personal dotfiles repository +## Install on a new system + +See [Acknowledgements](#Acknowledgements) for tutorial source. + +* Prior to the installation, create alias for config + * `alias config='/usr/bin/git --git-dir=$HOME/.cfg/ --work-tree=$HOME'` +* Add `.cfg` to `.gitignore` + * `echo ".cfg" >> .gitignore` +* Clone dotfiles into a bare repository + * `git clone --bare $HOME/.cfg` +* Define the alias in the current shell scope + * `alias config='/usr/bin/git --git-dir=$HOME/.cfg/ --work-tree=$HOME'` +* Checkout content from bare repository to `$HOME` + * `config checkout` +* Step above might fail with a message like: + * ``` + error: The following untracked working tree files would be overwritten by checkout: + .bashrc + .gitignore + Please move or remove them before you can switch branches. + Aborting + ``` +* Delete `.bashrc` and `.gitignore` + * `rm ~/.bashrc ~/.gitignore` +* Re-run checkout + * `config checkout` +* Set the flag `showUntrackedFiles` to `no` on this specific (local) repo + * `config config --local status.showUntrackedFiles no` + ## Acknowledgements I followed [DistroTube](https://www.youtube.com/channel/UCVls1GmFKf6WlTraIb_IaJg)'s process for setting up a git bare repository as shown in [Git Bare Repository - A Better Way To Manage Dotfiles](https://youtu.be/tBoLDpTWVOM).