Add typical installation instructions
This commit is contained in:
parent
330b719c78
commit
a2ac57af3d
1 changed files with 14 additions and 6 deletions
20
README.md
20
README.md
|
@ -1,6 +1,14 @@
|
||||||
# hi
|
# Spotlight's dotfiles
|
||||||
hi
|
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.
|
||||||
# why
|
|
||||||
idk
|
I make heavy usage of Git submodules. Occasionally, these are updated. Please ensure when pulling my dotfiles that you also `git submodule update`.
|
||||||
# ok
|
|
||||||
ok
|
## 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.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue