From a2ac57af3dc676b8cf83a4ca46baa8367fbc49da Mon Sep 17 00:00:00 2001 From: Spotlight Date: Mon, 10 May 2021 16:30:38 -0500 Subject: [PATCH] Add typical installation instructions --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 33400ee..ecffe98 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ -# hi -hi -# why -idk -# ok -ok +# Spotlight's dotfiles +On devices I consider personal, I like having a similar style within zsh. I heavily utilize macOS, BSD and various Linux, so it's important that these dotfiles work consistently across them all. + +I make heavy usage of Git submodules. Occasionally, these are updated. Please ensure when pulling my dotfiles that you also `git submodule update`. + +## Installation +``` +git clone --recursive https://git.joscomputing.space/spotlight/dotfiles ~/.dotfiles +cp ~/.dotfiles/dotfilesrc ~/.dotfilesrc +pip3 install dotfiles +dotfiles --sync --force +``` + +This creates a symbolic link from any file or directory within `~/.dotfiles/` to their respective place in `~/`. I prefer the `.dotfilesrc` to be managed as well.