nix-config/README.md

56 lines
1.8 KiB
Markdown
Raw Normal View History

# Dotfiles
> TODO: Screenshots
2017-10-21 11:35:09 +02:00
## Usage
2018-01-20 05:47:34 +01:00
### Replicate my [Arch Linux](/.archlinux) setup
2018-11-11 17:08:42 +01:00
On a fresh [Arch Linux][archlinux] install, run the bootstrap script.
```sh
git clone https:///github.com/GloverDonovan/dotfiles --depth 1 && ./dotfiles/.archlinux/bootstrap.sh
```
### Replicate my [Fedora](/.fedora) setup
On a fresh [Fedora][fedora] install, run the bootstrap script.
2018-01-01 03:55:37 +01:00
```sh
git clone https://github.com/GloverDonovan/dotfiles --depth 1 && ./dotfiles/.fedora/bootstrap.sh
```
2017-12-20 23:15:24 +01:00
### Use only the dotfiles you want
#### 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
[gnulinux]: https://www.gnu.org/gnu/linux-and-gnu.html
[freesw]: https://www.gnu.org/philosophy/free-sw.html
[stow]: https://www.gnu.org/software/stow/manual/stow.html