Refactor to reduce config in group_vars
This commit is contained in:
43
roles/dotfiles/README.md
Normal file
43
roles/dotfiles/README.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Dotfiles Deployment Guide
|
||||
|
||||
Deploy dotfiles using [GNU Stow](https://www.gnu.org/software/stow/).
|
||||
|
||||
Each subdirectory is a stow package corresponding to a set of related dotfiles.
|
||||
|
||||
## Deploy Dotfiles
|
||||
|
||||
Run Stow from within your dotfiles directory:
|
||||
|
||||
```sh
|
||||
cd ~/dotfiles
|
||||
stow bash
|
||||
stow vim
|
||||
stow git
|
||||
```
|
||||
|
||||
This will symlink the files into your `$HOME` directory.
|
||||
|
||||
## Deploy All Dotfiles
|
||||
|
||||
To deploy all dotfiles at once:
|
||||
|
||||
```sh
|
||||
stow *
|
||||
```
|
||||
|
||||
## Updating Dotfiles
|
||||
|
||||
1. Edit files in the respective subdirectories.
|
||||
2. Commit and push changes as usual with Git.
|
||||
|
||||
## Undoing a Stow
|
||||
|
||||
To remove symlinks created by Stow:
|
||||
|
||||
```sh
|
||||
stow -D bash
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
For more details, see the [GNU Stow manual](https://www.gnu.org/software/stow/manual/stow.html).
|
||||
Reference in New Issue
Block a user