README.md

dotfiles

Table of Contents

• About
  • Installing
  • Customizing
• Resources
  • .vim
• Contributing
  • Running the tests

About

Installing

$ make

This will create symlinks from this repo to your home folder.

Customizing

Save env vars, etc in a .extra file, that looks something like this:

###
### Git credentials
###

GIT_AUTHOR_NAME="Your Name"
GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
git config --global user.name "$GIT_AUTHOR_NAME"
GIT_AUTHOR_EMAIL="email@you.com"
GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
git config --global user.email "$GIT_AUTHOR_EMAIL"
GH_USER="nickname"
git config --global github.user "$GH_USER"

###
### Gmail credentials for mutt
###
export GMAIL=email@you.com
export GMAIL_NAME="Your Name"
export GMAIL_FROM=from-email@you.com

Resources

.vim

For my .vimrc and .vim dotfiles see github.com/jessfraz/.vim.

Contributing

Running the tests

The tests use shellcheck. You don't need to install anything. They run in a container.

$ make test