2018-10-23 05:29:52 +02:00
|
|
|
# Dotfiles
|
2017-12-27 03:05:01 +01:00
|
|
|
|
2018-10-23 05:29:52 +02:00
|
|
|
> TODO: Screenshots
|
2017-10-21 11:35:09 +02:00
|
|
|
|
2018-10-15 07:44:43 +02:00
|
|
|
## Usage
|
2018-01-20 05:47:34 +01:00
|
|
|
|
2018-10-30 16:22:45 +01:00
|
|
|
### Step 0. Clone this repository
|
2018-10-23 05:29:52 +02:00
|
|
|
|
2018-10-30 16:22:45 +01:00
|
|
|
- `git clone https://github.com/GloverDonovan/dotfiles.git --depth 1`
|
2018-10-23 05:29:52 +02:00
|
|
|
|
2018-10-30 16:22:45 +01:00
|
|
|
### Step 1. Install [stow][stow]
|
2018-10-23 05:29:52 +02:00
|
|
|
|
2018-10-30 16:22:45 +01:00
|
|
|
- [Arch Linux][archlinux]: `pacman -S stow`
|
|
|
|
|
- [Fedora][fedora]: `dnf install stow`
|
2018-10-23 05:29:52 +02:00
|
|
|
|
|
|
|
|
### Step 2. Install the dotfiles you want
|
|
|
|
|
|
|
|
|
|
For example, to use my vim config, run:
|
2018-01-01 03:55:37 +01:00
|
|
|
|
2018-10-30 16:22:45 +01:00
|
|
|
```sh
|
2018-10-23 05:29:52 +02:00
|
|
|
make package=vim
|
2018-10-15 07:44:43 +02:00
|
|
|
```
|
2017-12-20 23:15:24 +01:00
|
|
|
|
2018-10-30 16:22:45 +01:00
|
|
|
Since my dotfiles are managed with Stow, any of your existing dotfiles will not be overridden or changed.
|
2018-10-23 05:29:52 +02:00
|
|
|
|
|
|
|
|
## List of dotfiles
|
|
|
|
|
|
|
|
|
|
- [bspwm](/bspwm) - All the config files relating to my window manager setup.
|
|
|
|
|
- [code](/code) - My config for Code, a reasonable editor for non-vim users.
|
|
|
|
|
- [editorconfig](/editorconfig) - Spaces or tabs? Just use `.editorconfig`.
|
|
|
|
|
- [extras](/extras) - A collection of miscellaneous other dotfiles I use.
|
|
|
|
|
- [fish](/fish) - My settings for fish, the friendly interactive shell.
|
|
|
|
|
- [git](/git) - The standard version control tool.
|
|
|
|
|
- [gpg](/gpg) - My settings for GPG.
|
2018-10-30 16:22:45 +01:00
|
|
|
- [plasma](/plasma) - Dotfiles specific to KDE Plasma.
|
|
|
|
|
- [systemd](/systemd) - User services, such as ssh-agent and urxvtd.
|
2018-10-23 05:29:52 +02:00
|
|
|
- [tmux](/tmux) - A vim-like terminal multiplexer that gets out of your way.
|
|
|
|
|
- [vim](/vim) - The settings I use for vim, also known as the best editor.
|
|
|
|
|
- [xmodmap](/xmodmap) - Make caps lock function as ctrl and escape.
|
|
|
|
|
|
|
|
|
|
## Uninstall
|
|
|
|
|
|
2018-10-30 16:22:45 +01:00
|
|
|
If you don't want to use some of my dotfiles anymore, they can be easily uninstalled.
|
2018-10-23 05:29:52 +02:00
|
|
|
|
|
|
|
|
For example, if you don't want to use my `.vimrc` anymore, run:
|
|
|
|
|
|
2018-10-30 16:22:45 +01:00
|
|
|
```sh
|
2018-10-23 05:29:52 +02:00
|
|
|
make uninstall package=vim
|
|
|
|
|
```
|
2017-12-20 23:15:24 +01:00
|
|
|
|
2018-10-30 16:22:45 +01:00
|
|
|
This will only remove the files that Stow owns, while keeping your other files intact.
|
2018-09-01 07:04:33 +02:00
|
|
|
|
2018-10-15 07:44:43 +02:00
|
|
|
[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
|
