nix-config/README.md
Donovan Glover 700d99ae7c
docs: Update README
Fixed some typos and decreased the amount of repetitive information.
2018-10-30 11:24:23 -04:00

2.0 KiB

Dotfiles

TODO: Screenshots

Usage

Step 0. Clone this repository

  • git clone https://github.com/GloverDonovan/dotfiles.git --depth 1

Step 1. Install stow

Step 2. Install the dotfiles you want

For example, to use my vim config, run:

make package=vim

Since my dotfiles are managed with Stow, any of your existing dotfiles will not be overridden or changed.

List of dotfiles

  • bspwm - All the config files relating to my window manager setup.
  • code - My config for Code, a reasonable editor for non-vim users.
  • editorconfig - Spaces or tabs? Just use .editorconfig.
  • extras - A collection of miscellaneous other dotfiles I use.
  • fish - My settings for fish, the friendly interactive shell.
  • git - The standard version control tool.
  • gpg - My settings for GPG.
  • plasma - Dotfiles specific to KDE Plasma.
  • systemd - User services, such as ssh-agent and urxvtd.
  • term - Config for urxvt and termite. May apply elsewhere as well.
  • tmux - A vim-like terminal multiplexer that gets out of your way.
  • vim - The settings I use for vim, also known as the best editor.
  • wal - My additions to wal's color scheme application algorithm.
  • xmodmap - Make caps lock function as ctrl and escape.

Uninstall

If you don't want to use some of my dotfiles anymore, they can be easily uninstalled.

For example, if you don't want to use my .vimrc anymore, run:

make uninstall package=vim

This will only remove the files that Stow owns, while keeping your other files intact.