A collection of extremely opinionated config files, custom to me. You probably shouldn't use them. In fact, at this point, I am specifically waiving any responsibility for these, and offering no warranties, explicit or implied. If you use these, changes will be made to your system and account that can break a lot of things for you.
USE THESE AT YOUR OWN RISK. I offer no support for you if you use these and have issues. I'm happy to entertain suggestions, or have a friendly chat about why I made decisions on things, but issues or support requests will be closed and ignored.
NOTE 1: The installation script relies heavily on another of my little projects, bash-functions-library. You'll need to pull that in as a submodule as well after you've cloned this repo, with git submodule update.
NOTE 2: The installation script is extremely opinionated about what goes where. It will offer to install a lot of software, some of which it needs to complete its installations. It will offer to create empty local config file includes, or use existing ones. It will try to save any existing config files that exist with .BAK-{DateStamp} extensions, but doesn't make any promises that it will succeed. It doesn't clean up after itself if anything fails, but it will tell you what it's doing as it's doing it so that you can suss out what's been changed if something goes awry.
NOTE 3: This installation script will try to add {BREW_BIN_PATH}/bash as your default shell on macOS if you let it. If it changes it, but then you remove that shell for some reason, you're going to have a really bad time until you change your shell through System Preferences » Users & Groups » your user » right click » Advanced Options.
NOTE 4: The installation script expects to be run from the root of this repository. If you run it directly in the setup directory, it'll probably behave unexpectedly.
Have you read all of that, and you still want to use these? Alright, go hard.
- Change into the directory that you've pulled this repository from.
- Run the script
setup/bash-setup.sh.
First, the dotfiles themselves should never be modified. They represent the platonic ideal of a dotfile. Instead, you should only modify the .*_local file that corresponds to the file you would normally modify. This keeps your local modifications local, and keeps the multi-system generic configurations pristine.
Next, there are several configuration files that don't support including other files, that might be modified as you use the programs they correspond to. If this is the case, consider if these are local changes or generic changes, and commit them back to your copy of the repository as appropriate.
There's a lot of other dotfiles repos out there. I've borrowed ideas from a lot of them. Here's a few that I've liked over the years.
Here's an interesting article on Atlassian about how to use git to manage your configuration files. This might be a possible direction to take this repo, if only for experimentation.
- Decide how to deal with vim plugins.
- Download when desired wanted?
- Keep a version and install it?
- Add the installed version to
dot-vimand commit?
- Custom rollback script to remove dotfiles if something goes wrong, or you want to remove things.