This repo is a collection of my Neovim, tmux, zsh and atom configurations. This dotfile project is heavily inspired by Nick Nisi's dotfile project. See his talk vim + tmux - OMG! if you want to be inspired.
git clone https://github.com/nwaywood/dotfiles.git ~/.dotfilescd ~/.dotfilesbash install.sh
This install.sh script will start by installing all symbolic links into your home directory. Every file with a .symlink extension will be symlinked to the home directory with a . in front of it. As an example, zshrc.symlink will be symlinked in the home directory as ~/.zshrc. Then, all files in the $DOTFILES/config directory will be symlinked to the ~/.config/ directory for applications that follow the XDG base directory specification, such as Neovim.
Next, the script will check to see if the OS is MacOS. If so, it will install Homebrew (if its not already installed) and will install all the packages listed in install/brew.sh. Then, install/osx.sh will run and change some OSX configurations. Finally, zsh is configured and oh-my-zsh is installed.
In install/ folder there are other scripts for installing go, atom, and npm packages which are not automatated. If you want to install any of these packages, manually run the file (e.g. bash install/atom.sh).
Neovim is a fork and drop-in replacement for vim. in most cases, you would not notice a difference between the two, other than Neovim allows plugins to run asynchronously so that they do not freeze the editor, which is the main reason I have switched over to it. Vim and Neovim both use Vimscript and most plugins will work in both (all of the plugins I use do work in both Vim and Neovim). For this reason, they share the same configuration files in this setup. Neovim uses the XDG base directory specification which means it won't look for a .vimrc in your home directory. Instead, its configuration looks like the following:
| Vim | Neovim | |
|---|---|---|
| Main Configuratin File | ~/.vimrc |
~/.config/nvim/init.vim |
| Configuration directory | ~/.vim |
~/.config/nvim |
Vim is likely already installed on your system. If using a Mac, MacVim will be installed from Homebrew. Neovim will also be installed from Homebrew by default on a Mac. For other systems, you may need to install Neovim manually. See their web site for more information.
link.sh will symlink the XDG configuration directory into your home directory. Inside of .zshrc, the EDITOR shell variable is set to nvim, defaulting to Neovim for editor tasks, such as git commit messages. Additionally, I have aliased vim to nvim in aliases.zsh You can remove this if you would rather not alias the vim command to nvim.
Neovim plugins are managed with vim-plug. To install plugins, run:
nvim +PlugInstall
ZSH is configured in the zshrc.symlink file, which will be symlinked to the home directory. The following occurs in this file:
- set the EDITOR to nvim
- Recursively search the $DOTFILES/zsh directory for files ending in .zsh and source them
- Setup
oh-my-zshand install plugins - Add the ~/bin and $DOTFILES/bin directories to the path
- And more...
nick.zsh-theme contains my custom terminal prompt. If you would like to use it, manually copy it into ~/.oh-my-zsh/custom/themes or change ZSH_THEME in zshrc.symlink from nick to one of the built-in themes (e.g. robbyrussell)
Tmux is a terminal multiplexor which lets you create windows and splits in the terminal that you can attach and detach from. I use it to keep multiple projects open in separate windows and sessions and to create an IDE-like environment to work in where I can have my code open in Neovim and a shell open to run tests/scripts. Tmux is configured in ~/.tmux.conf, and in tmux/theme.sh, which defines the colors used, the layout of the tmux bar, and what what will be displayed, including the time and date, open windows, tmux session name, computer name. If not running on macOS, this configuration should be removed.
Tmux plugins are managed with tpm. To install plugins, run:
<prefix> - I
from within tmux. This installs the tmux-resurrect plugin which lets tmux sessions/windows/panes be persisted across OS reboots. prefix - ^s to save the tmux environment and prefix - ^r to restore the tmux environent.