Dotfiles

This repo contains my dotfiles. It provides default configuration for the set of applications that I use every day in the terminal, and works in a cross-platform manner between MacOS and Linux. It provides configuration for the following:

• git: A sensible gitconfig where user name, email and GPG key can be set at install time, as well as a sensible global gitignore. The gitconfig is set up to work with this gitignore.
• hammerspoon: A config with a few useful utilities (MacOS only).
• intellij: A config for IdeaVim to provide some sensible default configuration for editing.
• karabiner: A simple configuration that remaps Ctrl and Fn, and also makes caps lock behave as Esc when pressed and Ctrl when held (MacOS only),
• neovim: A detailed configuration containing years-worth of work to get the fluid editing of vim with comprehensive IDE features for Haskell, C++, Python, Scala, Rust, and a variety of other languages.
• tmux: A configuration that makes using tmux truly intuitive, and also allows for seamless interoperation with Neovim.
• zsh: A configuration that makes my favourite shell even better and more fluid to use, including a custom theme with a useful prompt clock.

All of this configuration is, of course, incredibly personal, so I don't expect anybody to use it without making changes. Nevertheless, if you find yourself taking a look at this readme, I hope you find the configuration instructive or useful in some way.

Installation

This repo comes with a simple install script that eases the installation process and makes getting set up on a new machine fairly simple. As a prerequisite, you will need the above listed programs installed to make use of the configuration.

1. Clone the repository into ~/.dotfiles. The install script isn't precious about this location, but some of the configuration relies on it.

   git clone https://github.com/iamrecursion/dotfiles ~/.dotfiles
   

2. Execute the install script. You may need to explicitly tell it which bash to use if you fail the compatibility check (common on MacOS).

   ~/.dotfiles/install.sh
   

3. When prompted, enter your name, email and GPG key for git.

4. Follow the final setup instructions printed to the terminal.

Most files will be symlinked from the repo, though some will be copied into their final locations.

NB: This will overwrite any existing configuration that exists at the target paths, so if you want to try these out please back up your configuration.

Credits

This repository and readme makes use of the Dotfiles Logo kindly created and provided by Joel Glovier.