extern/nix-config
1
0
Fork 1
mirror of https://github.com/donovanglover/nix-config.git synced 2024-11-22 08:14:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update README

Browse Source 
Since many people would want to pick and choose which dotfiles to
use, it makes sense to improve the instructions for this use case.
This commit is contained in:
Donovan Glover 2018-11-25 22:45:01 -05:00
parent 397ee54082
commit a0d1211a89
No known key found for this signature in database
GPG Key ID: EA7408A77AE1BE65
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -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