leycec/dotfiles

Welcome to leycec's dotfile suite.

Installation

Dotfiles are a gritty business. Hand me my CLI shovel.

vcsh (Recommended)

These dotfiles are preferably installed via vcsh, a Git-centric Bourne shell script for portable management and publication of dotfiles. vcsh cleverly leverages Git internals rather than littering your filesystem with a battery of fragile symbolic links. ^{You know this to be a good thing.}

• Install vcsh. Specifically, under:

  • Gentoo-based Linux distros (e.g., Calculate):

        $ sudo emerge vcsh
    

  • Debian-based Linux distros (e.g., Ubuntu):

        $ sudo apt-get install vcsh
    

  • Platforms providing no vcsh package (e.g., Cygwin):

        $ git clone https://github.com/RichiH/vcsh && cd vcsh && sudo make install
    

• Move aside any existing dotfiles. Renaming an existing ~/.gitconfig file to ~/.gitconfig.d/user.cfg ensures that your Git dotfile will be sourced by our Git dotfile on each invocation of Git.

    $ mkdir ~/.gitconfig.d && mv ~/.gitconfig ~/.gitconfig.d/user.cfg
  

• Install this suite of dotfiles.

    $ vcsh clone https://github.com/leycec/dotfiles.git
  

• (Optional) Inform Git of your resplendent identity by appending the following lines to the newly created ~/.gitconfig.d/user.cfg file:

    [user]
         name = <ENTER NAME UNQUOTED HERE>
         email = <ENTER E-MAIL UNQUOTED HERE>
  

• (Optional) For fellow Github developers:

  • Enter the cloned repository.

        $ vcsh enter dotfiles
    

  • Track the github branch, storing front-facing GitHub documentation (including the current file).

        $ git fetch origin github
    

  • Install a Git post-commit hook, synchronizing the master and github branches on every commit to the former.

        $ ln -s $HOME/.githook.d/dotfiles.post-commit $GIT_DIR/hooks/post-commit
    

  • Leave the cloned repository.

        $ exit
    

• (Optional) Install our Vim dotfiles. Vim is the spicy entrails of command-line life. For additional danger, why not leycec/vimrc?

You're done. Praise be to the open-source Christmas Krampus.

License

All dotfiles are liberally licensed under the University of Illinois/NCSA Open Source License, a hospitably lax license for the whole POSIX-compatible family.