Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.67 KB

README.md

File metadata and controls

41 lines (24 loc) · 1.67 KB
Raw

dotfiles

Install dotfiles on your OS X workstation. Inspriration from holman does dotfiles by Holman.

Note: This project is extremly powerfull in combination with the Workstation project for setting up your development environment.

Requirements

Make sure that Oh-My-Zsh, a framework for your ZSH configuration website github is installed.

Install

Run the installation script:

$ ./script/install.sh

Workings

The installation script works as follows:

  1. It symlinks the project to the $HOME directory into a directory called .dotfiles (e.g. ~/.dotfiles)
  2. It installs the ZSH themes to the $HOME/.oh-my-zsh/themes directory
  3. It installs the files ending in *.symlink to the $HOME directory

Usage

The dotfiles are split up per 'topic' or 'catagory', which is just a directory. The extension on the dotfile decides how the file is handeld:

  • *.zsh: File will get automatically loaded into your shell
  • *.symlink: File will get symlinked to the $HOME directory
  • path.zsh: File will be loaded first and is expected to setup $PATH or similar
  • completion.zsh: File will be loaded last and is expected to setup autocomplete

However some dotfiles are a bit special, these exsist in a special directory:

  • ./bin/*: Any file in ./bin/ will get added to your $PATH and be made available everywhere (e.g. subl)

The dotfiles allow to set up project aliases, these aliases are automatically loaded into your shell. To enable a project alias, create a .alias file in the project directory.