From a0d1211a89a7b5f1f56f876f7a211d726e9b846b Mon Sep 17 00:00:00 2001 From: Donovan Glover Date: Sun, 25 Nov 2018 22:45:01 -0500 Subject: [PATCH] docs: Update README Since many people would want to pick and choose which dotfiles to use, it makes sense to improve the instructions for this use case. --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a6f4588..aa237ae 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,31 @@ git clone https://github.com/GloverDonovan/dotfiles --depth 1 && ./dotfiles/.fed ### Use only the dotfiles you want -Install [`stow`][stow] with your package manager, then use `make package=dir` and `make uninstall package=dir` as needed. Stow will only change what it owns. +#### Method 1. With [`stow`][stow] + +First, install stow with your package manager. Then, run the following: + +```sh +make package=kitty +``` + +This will symlink my kitty config to your `$XDG_CONFIG_HOME`. If you want to install a different package, simply replace `kitty` with the name of the directory you wish to get dotfiles from. + +Since `stow` will only change what it owns, you do not have to worry about any of your existing dotfiles being changed when you use this method. + +To uninstall packages, simply use: + +```sh +make uninstall package=kitty +``` + +This will remove the symlink to my kitty config. If you have other kitty files, stow will not remove them, since stow only changes what it owns. + +#### Method 2. Manually + +If you already have dotfiles and want to improve them, you can use this repository as a guide. If you find something that makes your dotfiles better, you're free to use it. + +If you don't want to use stow, you can simply copy/paste the dotfiles you want to their relevant directories. [archlinux]: https://www.archlinux.org [fedora]: https://getfedora.org