dotfiles

A personal set of Unix "dotfiles" to configure various programs.

License

Table of Contents

• Installation
  • Workstation
  • homeshick
  • Homesick
• Issues
• Contributing
• Authors
• License

Installation

Workstation

The author mainly consumes this project via a Workstation automation project which sets up and manages several homeshick repos across Linux, macOS, and FreeBSD. See the Workstation project for more details.

homeshick

This project is structured to work with homeshick which uses Git to track updates and changes. Installing homeshick involves cloning a Git repository and loading a shell function:

# Clone the codebase repo
git clone https://github.com/andsens/homeshick.git "$HOME/.homesick/repos/homeshick"
# Add the shell function to Bash shell sessions
printf '\nsource "$HOME/.homesick/repos/homeshick/homeshick.sh"' >> $HOME/.bashrc
# Load the function into the current shell
source "$HOME/.homesick/repos/homeshick/homeshick.sh"

If you are installing on macOS and use Homebrew, then you can optionally install homeshick with:

brew install homeshick

Finally, add this repository to your setup with:

homeshick clone fnichol/dotfiles

Then keep up to date with:

homesick pull dotfiles && homesick link dotfiles

See the homeshick project's documentation for more detailed usage (it's pretty great).

Homesick

Homesick is an older Ruby-based project which predates homeshick and works in a very similar way. To install Homesick you will need an installation of Ruby present and then simply:

gem install homesick

Finally, add this repository to your setup with:

homesick clone git://github.com/fnichol/dotfiles.git
homesick pull dotfiles && homesick symlink dotfiles

Then keep up to date with:

homesick pull dotfiles && homesick symlink dotfiles

Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue.

Contributing

You are invited to contribute to new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Note that this project represents a very personalized workflow and setup and so not all new features may ultimately be included. Don't be afraid to engage however, the author is especially nerdy about configuration and workstation setup ;)

Authors

Created and maintained by Fletcher Nichol (fnichol@nichol.ca).

License

Licensed under the MIT license (LICENSE.txt or http://opensource.org/licenses/MIT)