README

Included Configuration Files

These are the configuration files (dot files) that I use for my MacBook and Ubuntu servers/slices. Some of the configuration files include:

• bash
• chktex
• eslint
• git
• neovim
• npm
• rvm
• tmux
• zsh

In October 2023, I converted my old Vim configuration using mainly Vim script to Neovim using Lua.

Initial Setup

To start using this repository, run:

1. Clone the repositoiry using git clone https://github.com/matthewrankin/dotfiles.git
2. Deploy the dot-files by running ./deploy_dot_files.py, which will create aliases in the proper directories.

Update from Github

Whenever you want to pull the latest updates from GitHub use:

$ git pull

What does deploy_dot_files.py actually do?

This script does the following:

• Expects to be run from the directory containing the dot-files that have been cloned from github (e.g., /Users/me/dev/dot-files/)
• On a per file basis, checks to see if symlinks from the user's home directory to the dot-files directory already exist and checks to make sure that the file in the dot-files directory does exist.
• If a symlink does not exist but the file does exist in the dot-files directory, then the current file in the user's home directory will be backed up and a symlink will be created
• By using symlinks instead of copying files, the deploy_dot_files.py script only needs to be run one time. To update simply clone the github repository using git pull.

License

dotfiles is released under the MIT license. Please see the LICENSE.txt file for more information.