Introduce default.nix for Nix users.

This file can be used to get in an environment ready to compile Coq
(with `nix-shell`) or to compile and install Coq (with `nix-build`).

1 files changed, 64 insertions, 0 deletions

diff --git a/default.nix b/default.nix
new file mode 100644
index 000000000..9efabdbc2
--- /dev/null
+++ b/default.nix
@@ -0,0 +1,64 @@
+# How to use?
+
+# If you have Nix installed, you can get in an environment with everything
+# needed to compile Coq and CoqIDE by running:
+# $ nix-shell
+# at the root of the Coq repository.
+
+# How to tweak default arguments?
+
+# nix-shell supports the --arg option (see Nix doc) that allows you for
+# instance to do this:
+# $ nix-shell --arg ocamlPackages "(import <nixpkgs> {}).ocamlPackages_latest" --arg buildIde false
+
+# You can also compile Coq and "install" it by running:
+# $ make clean # (only needed if you have left-over compilation files)
+# $ nix-build
+# at the root of the Coq repository.
+# nix-build also supports the --arg option, so you will be able to do:
+# $ nix-build --arg doCheck false
+# if you want to speed up things by not running the test-suite.
+# Once the build is finished, you will find, in the current directory,
+# a symlink to where Coq was installed.
+
+{ pkgs ? (import <nixpkgs> {}), ocamlPackages ? pkgs.ocamlPackages,
+  buildIde ? true, doCheck ? true }:
+
+with pkgs;
+
+stdenv.mkDerivation rec {
+
+  name = "coq";
+
+  buildInputs = (with ocamlPackages; [
+
+    # Coq dependencies
+    ocaml
+    findlib
+    camlp5_strict
+
+  ]) ++ (if buildIde then [
+
+    # CoqIDE dependencies
+    ocamlPackages.lablgtk
+
+  ] else []) ++ (if doCheck then [
+
+    # Test-suite dependencies
+    python
+    rsync
+    which
+
+  ] else []);
+
+  src =
+    if lib.inNixShell then null
+    else
+      with builtins; filterSource
+        (path: _: !elem (baseNameOf path) [".git" "result" "bin"]) ./.;
+
+  prefixKey = "-prefix ";
+
+  inherit doCheck;
+
+}