From a6624e97790d4d101d77427c06a8dc09da86b3ea Mon Sep 17 00:00:00 2001 From: Thomas White Date: Wed, 14 Jun 2023 12:29:04 +0200 Subject: INSTALL.md: Advertise Homebrew formula --- INSTALL.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index bd2105a2..e9b6ccdf 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -52,6 +52,8 @@ available on [their website](http://apptainer.org/). Installation via package manager -------------------------------- +### Nix + CrystFEL is available through NixOS since 22.05, for x86_64, Darwin and aarch64. Two packages are available. Package `crystfel` contains all tools including the GUI, @@ -62,8 +64,23 @@ To install via NixOS, simply add the package globally to your `environment.systemPackages`, or enter a temporary shell via `nix shell nixpkgs#crystfel` to have all CrystFEL tools in your `PATH`. -Packages for other systems (e.g. Homebrew) are -under development! +### Homebrew + +To install the development version of CrystFEL using +Homebrew, run the following: +``` +$ git clone https://gitlab.desy.de/thomas.white/crystfel.git +$ cd crystfel +$ brew install -v -s ./crystfel.rb --HEAD +``` +Normally, CrystFEL's build system would automatically download and install +certain dependencies, notably (among others) XGandalf, MTZ output, PinkIndexer +and PeakFinder9. However, Homebrew prefers that packages do not do this. +Therefore, unless you've installed them separately, the CrystFEL installation +made this way will lack some features. + +We hope to contribute the Homebrew formula to the main repository soon, so that +you can install CrystFEL with a simple `brew install crystfel`. Dependencies -- cgit v1.2.3