aboutsummaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2023-06-14 12:29:04 +0200
committerThomas White <taw@physics.org>2023-06-14 12:29:21 +0200
commita6624e97790d4d101d77427c06a8dc09da86b3ea (patch)
tree2bff5a2799839381f141f781477af05f4737615f /INSTALL.md
parent4adb678b554a23f8de43536a34373599f595ccbb (diff)
INSTALL.md: Advertise Homebrew formula
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md21
1 files 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 <a href="https://nixos.org/">NixOS</a> 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. <a href="https://brew.sh/">Homebrew</a>) are
-under development!
+### Homebrew
+
+To install the development version of CrystFEL using
+<a href="https://brew.sh/">Homebrew</a>, 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