Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.63 KB

README.md

File metadata and controls

65 lines (44 loc) · 2.63 KB
Raw

Configuration files for various tools

Prerequisites

I have tested most of these files only on Linux.

For cross-platform tools like neovim you can manually copy and install their config files.

GNU stow should be used to install these files. Check out the documentation of stow by running info stow and check out how to manage your dotfiles with stow here.

Run stow -V and make sure your version is at least 2.4.0 since earlier GNU stow versions have a bug with regards to the --dotfiles flag.

Structure

Each tool has its own directory. For example neovim has the nvim folder at the root of this repo but its actual configuration files are located in nvim/dot-config/nvim/. This structure makes it easy to install these files with stow.

Usage

First read the prerequisites section if you haven't already.

I'll use neovim as an example tool below but these steps apply to everything else.

  • cd $HOME (you need to cd in the home directory or else manually set stow's --target flag to the directory where the files should be installed)
  • git clone --recurse-submodules https://github.com/sus-domesticus/dotfiles (the --recurse-submodules flag is needed because some of the tools (neovim included) have their own repos embedded as submodules in this repo)
  • cd dotfiles (cd to the root of this freshly-cloned repo)
  • read the follow-up instructions from the neovim subsection. (for other tools see their respective subsections in the tools section)

Tools

This section describes general information like prerequisites, tips and tricks etc. for each tool. You should first follow the steps from the usage section (if you haven't already) and then come here for specific tool setup instructions/knowledge.

Each tool has its own subsection below.

neovim

Common pitfalls

  • If the nvim/dot-config/nvim/ directory is empty you probably forgot to update or initialize the git submodules (something like git submodule update --init --recursive should solve this problem).

tmux

The config files have been tested for tmux 3.4. (run tmux -V to check your version)

  • stow --dotfiles tmux