/dotfiles

My set of configuration files.

Primary LanguageVim Script

Painted-Fox/dotfiles

These are my personal dotfiles. Everyone has their own way to organize and handle their dotfiles and everyone's configurations are personal. My dotfiles will unlikely serve your needs, so beware if you try to install them, but it's certainly safe to read them for inspiration for how you want to organize and handle your own dotfiles.

I use my dotfiles on Linux and Windows.

Installing Prerequisites

Before installing the dotfiles, there are some prerequisites. These are just prerequisites for installing the dotfiles, not a list of all the tools the dotfiles configure.

  • Git is needed to grab the dotfiles themselves. It's also required to install Vim plugins.
  • Mercurial (also known as the command hg) is used to retrieve Mercurial extentions. TortoiseHg is highly recommended for Windows and comes with dulwich.
  • Python is needed to run the bin/bootstrap script. Version 3.2 or higher is required on Windows.
  • dulwich is a python library that provides an interface to git repos. This is a requirement for the Mercurial extension hg-git, which enables using Mercurial with git repos. It's enabled in my hgrc so it's nice to install this early to avoid errors when running the hg command.

On Ubuntu, run the following to install prerequisites:

sudo apt-get install mercurial git python-dulwich

Getting the Dotfiles

My dotfiles expect to be saved to ~/lib/dotfiles and they can be retrieved via ssh...

git clone git@github.com:Painted-Fox/dotfiles.git ~/lib/dotfiles

...or via https:

git clone https://github.com/Painted-Fox/dotfiles.git ~/lib/dotfiles

Installing the Dotfiles

On Linux, run the following command in the terminal:

~/lib/dotfiles/bin/bootstrap

On Windows, run a command prompt as administrator and run the following (assuming python is in your PATH):

python %USERPROFILE%\lib\dotfiles\bin\bootstrap

Installing Vim Plugins

After installing the dotfiles, the next step is usually to install Vim plugins. I use vim-plug, a minimalist Vim plugin manager. To install the plugins, run Vim and run the following command within Vim:

:PlugInstall