Skip to content

A Community Collective of Role Specific Brewfiles 🍺

License

Notifications You must be signed in to change notification settings

dansholds/brewfiles

Repository files navigation

Brewfiles

Homebrew GitHub forks GitHub stars GitHub issues Peerlist

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.


πŸš€ What is a Brewfile?

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.


πŸ“¦ How to Use a Brewfile

  1. Clone the Repository:

    git clone https://github.com/dansholds/brewfiles.git
    cd brewfiles
  2. Choose a Brewfile: Browse through the available Brewfiles in the repository and select one that suits your needs.

  3. Install Packages: Use the brew bundle command to install the packages listed in the selected Brewfile:

    brew bundle --file=path/to/Brewfile

🀝 How to Contribute

We welcome contributions from the community! Follow these steps to add your Brewfile to the repository:

  1. 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.

  2. Clone Your Fork:

    git clone https://github.com/<your-username>/brewfiles.git
    cd brewfiles
  3. Create a New Branch:

    git checkout -b your-branch-name
  4. Create your Brewfile

    brew bundle dump --file=Brewfile
  5. 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 or data-science/Brewfile. If the purpose or environment already exists, use something that makes it unique.

  6. Commit Your Changes:

    git add .
    git commit -m "Add Brewfile for [describe environment]"
  7. Push to Your Fork:

    git push origin your-branch-name
  8. 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.


πŸ“ Directory Structure

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

πŸ“œ License

This repository is licensed under the MIT License. See the LICENSE file for more details.


πŸ“ž Contact

If you have any questions or suggestions, feel free to open an issue or contact the repository maintainers.

Happy brewing! 🍻

Releases

No releases published

Packages

No packages published

Languages