This repo aims to be a simple and straightforward way to begin persisting and your development environment. You are encouraged to fork this repo and make it your own! The simple architecture of this repo will get you most of what you want and need in creating a persistent and reproducible development environment, that can be recreated on a fresh computer with 1 command.
This template uses Strap as the foundation for creating a reproducible development environment. Please read the README for the strap project.
Once you have strap as described in this project, simply running bash bin/strap.sh will get a fresh machine up and running.
After strap is run, there will be symlink in your home directory ~/.Brewfile that will be linked to dot/Brewfile inside of this repo. The location of ~/.Brewfile is the expected location of the brew bundle --global command, which will magically download and install all of the software enumerated in your Brewfile.
We recommend that you use this ongoing with the following steps. Rather than simply running brew install xyz you can persist this long term by:
# Add the software to your `~/.Brewfile`
brew 'ag'
# Install all of the software on your Brewfile (including the change you just made)
brew bundle --global
# Commit your dotfiles repo. Because your home directory .Brewfile is symlinking to your dotfiles repo, your modification will be known to git and ready to be added and committed.
git commit -am "Added ag to Brewfile"
Following this method will give you a versioned declaritive definition of your system software, reproducible and available to you for the long term.
Brew bundle is the best way to persist your MacOS system software. Read more about it, and the file format for Brewfile here: https://github.com/Homebrew/homebrew-bundle.
All files in the dot and files subdirectories will be symlinked to your home directory when script/setup is run, during the strap process. All files in the dot directory will be symlinked with a . (dot) prefixed to the file. All files in the file directory will be symlinked with no change to the file name. The prefixing of a dot allows the files to be treated as a hidden file in your home directory, while appearing a regular file in your repository.
For script changes that need to be executed run before homebrew installs the files, add the modifications to script/setup. For changes that need to be executed after homebrew installs the files, add the modifications to script/strap-after-setup.
The script dir contains two files, setup and strap-after-setup. These files are both called from Strap during it's execution.
All files in the dot directory will be symlinked with a . (dot) prefixed to the file. The prefixing of a dot allows the files to be treated as a hidden file in your home directory, while appearing a regular file in your repository.
All files in the file directory will be symlinked with no change to the file name.
That's it!