You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fixed two remaining issues from Copilot review:
1. **Document toolchain installation rationale**
- Added detailed comment explaining why full toolchain is needed
- Documents dependencies: util.sh, main.py, bootstrap/, templates/
- Clarifies this is not unnecessary bloat but required functionality
2. **Add syntax highlighting to code blocks**
- Added 'bash' language identifier to all shell command blocks
- Improves documentation readability
- Fixed blocks at lines 62, 74, 83, 137
3. **Update environment documentation**
- Removed outdated references to hardcoded compiler variables
- Updated to reflect reliance on Homebrew's superenv
- Clarified BOOST_INCLUDE is set in wrapper, not during build
All documentation now accurately reflects the current implementation
and provides proper syntax highlighting for better user experience.
Copy file name to clipboardExpand all lines: packaging/homebrew/HOMEBREW.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,25 +41,25 @@ Runtime dependencies (needed to run MFC):
41
41
42
42
The formula executes the following steps during installation:
43
43
44
-
1. Sets up environment variables for compilers and libraries
45
-
2. Runs `./mfc.sh build` to compile all three binaries
46
-
3. Installs binaries to Homebrew's bin directory
47
-
4. Creates a wrapper script that sets up the environment
48
-
5. Installs Python toolchain and examples
44
+
1. Runs `./mfc.sh build` to compile all three binaries
45
+
2. Installs binaries to Homebrew's bin directory
46
+
3. Installs mfc.sh to libexec for script execution
47
+
4. Installs Python toolchain (required for mfc.sh functionality)
48
+
5. Installs examples to share directory
49
+
6. Creates a wrapper script that sets up the environment
49
50
50
51
### Environment Configuration
51
52
52
-
The formula ensures proper environment setup:
53
-
- BOOST_INCLUDE points to Homebrew's boost installation
54
-
- FC (Fortran compiler) is set to gfortran
55
-
- CC (C compiler) is set to gcc
56
-
- CXX (C++ compiler) is set to g++
53
+
The formula relies on Homebrew's automatic environment setup:
54
+
- Compiler flags are set via the `gcc` dependency (Homebrew's superenv)
55
+
- Library paths are automatically configured
56
+
- The wrapper script sets BOOST_INCLUDE at runtime for user commands
57
57
58
58
### Wrapper Script
59
59
60
60
The installed `mfc` wrapper provides the complete MFC interface. It automatically configures the environment and delegates to the main `mfc.sh` script. Users can run any MFC command through this wrapper:
61
61
62
-
```
62
+
```bash
63
63
mfc build
64
64
mfc run examples/case.py
65
65
mfc test
@@ -71,7 +71,7 @@ mfc clean
71
71
### Standard Installation
72
72
73
73
Users install MFC with:
74
-
```
74
+
```bash
75
75
brew install mfc
76
76
```
77
77
@@ -80,7 +80,7 @@ This fetches the source tarball from GitHub releases, verifies the checksum, and
80
80
### Development Installation
81
81
82
82
For the latest development version:
83
-
```
83
+
```bash
84
84
brew install --HEAD mfc
85
85
```
86
86
@@ -134,7 +134,7 @@ Submit a pull request to homebrew-core for inclusion in the main Homebrew reposi
134
134
135
135
### Third-Party Tap
136
136
Create a separate tap (custom repository) for immediate availability:
0 commit comments