Add README for Homebrew tap and auto-deploy it

- Create packaging/homebrew/README.md with user-friendly tap documentation
- Update deploy-tap.yml to copy README to tap repository
- README includes installation, quick start, usage, and documentation links
- Low-maintenance design that stays current automatically

Author: sbryngelson

.github/workflows/deploy-tap.yml

@@ -79,19 +79,20 @@ jobs:
             git push -u origin main
           fi
 
-      - name: Copy formula into tap
+      - name: Copy formula and README into tap
         run: |
           mkdir -p tap-repo/Formula
           cp packaging/homebrew/mfc.rb tap-repo/Formula/mfc.rb
+          cp packaging/homebrew/README.md tap-repo/README.md
 
       - name: Commit & push if changed
         env:
           TAP_TOKEN: ${{ secrets.TAP_REPO_TOKEN }}
         run: |
           cd tap-repo
-          git add Formula/mfc.rb
+          git add Formula/mfc.rb README.md
           if git diff --cached --quiet; then
-            echo "No changes in Formula/mfc.rb; skipping push."
+            echo "No changes in Formula/mfc.rb or README.md; skipping push."
             exit 0
           fi
           git -c user.name="github-actions[bot]" -c user.email="github-actions[bot]@users.noreply.github.com" \

packaging/homebrew/README.md

@@ -0,0 +1,60 @@
+# MFC Homebrew Tap
+
+Official Homebrew tap for [MFC (Multiphase Flow Code)](https://github.com/MFlowCode/MFC) – an exascale multiphase/multiphysics compressible flow solver.
+
+## Installation
+
+```bash
+brew install mflowcode/mfc/mfc
+```
+
+## Quick Start
+
+Run the 1D Sod shock tube example:
+
+```bash
+mkdir -p ~/mfc_example && cd ~/mfc_example
+cp $(brew --prefix mfc)/examples/1D_sodshocktube/case.py .
+mfc run case.py -n 2
+```
+
+## What's Included
+
+- **Prebuilt binaries**: `pre_process`, `simulation`, `post_process`
+- **Python toolchain**: Pre-configured virtual environment with all dependencies (including Cantera)
+- **Examples**: Located at `$(brew --prefix mfc)/examples/`
+- **`mfc` wrapper**: Simplified command-line interface for running cases
+
+## Usage
+
+```bash
+mfc run <case.py> -n <processes>
+```
+
+Use `-n X` to set the number of MPI processes.
+
+**Note**: The Homebrew wrapper supports only `mfc run`. For developer commands (`build`, `test`, `clean`, etc.), [clone the repository](https://github.com/MFlowCode/MFC) and use `./mfc.sh`.
+
+## Documentation
+
+- [MFC Documentation](https://mflowcode.github.io/)
+- [Getting Started Guide](https://mflowcode.github.io/documentation/md_getting-started.html)
+- [Running Cases](https://mflowcode.github.io/documentation/md_running.html)
+
+## About This Tap
+
+This tap is automatically maintained by the [MFC repository](https://github.com/MFlowCode/MFC) via GitHub Actions. The formula is synced from [`packaging/homebrew/mfc.rb`](https://github.com/MFlowCode/MFC/blob/master/packaging/homebrew/mfc.rb).
+
+For issues or contributions related to the Homebrew formula, please visit the [main MFC repository](https://github.com/MFlowCode/MFC).
+
+## Uninstall
+
+```bash
+brew uninstall mfc
+brew untap mflowcode/mfc
+```
+
+## License
+
+MFC is licensed under the [MIT License](https://github.com/MFlowCode/MFC/blob/master/LICENSE).
+