Skip to content

README: Add clarifications about LLVM use on macOS/Homebrew #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bonachea wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README: Add clarifications about LLVM use on macOS/Homebrew #288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,14 @@ of a given compiler suite installation. The C++ compiler is optional for
single-node deployments (and can be disabled using command-line option `--without-cxx`),
but C++ is required for some network backends.

*Note for macOS/Homebrew users*: Homebrew may be used to install
[LLVM flang](https://formulae.brew.sh/formula/flang) for use with Caffeine, however
by default Homebrew will not replace the incompatible Apple-provided `clang` in your `PATH`.
Such users are recommended to use Homebrew's version-suffixed compiler variants,
for example setting `FC=flang-21 CC=clang-21 CXX=clang++-21` in the command above,
to ensure that a matching set of LLVM compilers are used.
See also [issue #228](https://github.com/BerkeleyLab/caffeine/issues/228).

The `install.sh` recognizes a number of command-line options and environment variables to
customize behavior for your system. See the output of `./install.sh --help` for full documentation,
including options for how to build for a distributed-memory platform.
Expand Down