aboutsummaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2023-03-01 10:31:08 +0100
committerThomas White <taw@physics.org>2023-03-01 11:48:26 +0100
commit318692ac9fced94ff99d41ee88fdf9ab44444589 (patch)
tree34375e746ec5042740ba93cb1b5dfa21472c698e /INSTALL.md
parentcd902972480e774f9f0cdfb7dd533f6f4ba91e60 (diff)
INSTALL.md: Mention NixOS
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
index ca0ba57a..dc54b2f6 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -23,6 +23,23 @@ and also to make sure that the installation is documented on the list of
supported facility installations.
+Installation via package manager
+--------------------------------
+
+CrystFEL is available through <a href="https://nixos.org/">NixOS</a> since
+22.05, for x86_64 and Darwin (aarch64 to follow soon). Two packages are
+available. Package `crystfel` contains all tools including the GUI,
+whereas `crystfel-headless` excludes the GUI, making it easier to
+install and more suitable for (e.g.) backend data processing servers.
+
+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!
+
+
Dependencies
------------