Welcome to the Brewfiles Repository! This is a community-driven project where users can share their Brewfile
configurations. By contributing to this repository, you can help others quickly set up their macOS or Linux environments with Homebrew.
A Brewfile
is a convenient way to describe the setup of your Homebrew packages, casks, and taps. It allows you to install all your dependencies with a single command. This is particularly useful for setting up a new machine or sharing your development environment with others.
-
Clone the Repository:
git clone https://github.com/dansholds/brewfiles.git cd brewfiles
-
Choose a Brewfile: Browse through the available
Brewfile
s in the repository and select one that suits your needs. -
Install Packages: Use the
brew bundle
command to install the packages listed in the selectedBrewfile
:brew bundle --file=path/to/Brewfile
We welcome contributions from the community! Follow these steps to add your Brewfile
to the repository:
-
Fork the Repository: Click the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.
-
Clone Your Fork:
git clone https://github.com/<your-username>/brewfiles.git cd brewfiles
-
Create a New Branch:
git checkout -b your-branch-name
-
Create your Brewfile
brew bundle dump --file=Brewfile
-
Add Your Brewfile: Place your
Brewfile
in a new directory named after the main purpose or the environment it sets up, for example,web-development/Brewfile
ordata-science/Brewfile
. If the purpose or environment already exists, use something that makes it unique. -
Commit Your Changes:
git add . git commit -m "Add Brewfile for [describe environment]"
-
Push to Your Fork:
git push origin your-branch-name
-
Create a Pull Request: Go to your fork on GitHub, and you should see a "Compare & pull request" button. Click it and submit your pull request.
Please follow this directory structure when adding your Brewfile:
brewfiles/
βββ README.md
βββ <category>/
β βββ GitHub Username (i.e, dansholds)
| βββ Brewfile
Examples of categories include:
web-development
data-science
machine-learning
devops
design
This repository is licensed under the MIT License. See the LICENSE file for more details.
If you have any questions or suggestions, feel free to open an issue or contact the repository maintainers.
Happy brewing! π»