From 9335cc09090bfba1f81f81c35e0acb324bf6cba5 Mon Sep 17 00:00:00 2001
From: Vincent Laporte
Date: Fri, 23 Nov 2018 09:29:04 +0000
Subject: [nix-ci] Add a README in dev/ci/nix

---
 dev/ci/nix/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 dev/ci/nix/README.md

(limited to 'dev')

diff --git a/dev/ci/nix/README.md b/dev/ci/nix/README.md
new file mode 100644
index 0000000000..1685b084e9
--- /dev/null
+++ b/dev/ci/nix/README.md
@@ -0,0 +1,19 @@
+# Working on third-party developments with *this* version of Coq
+
+Aim: getting an environment suitable for working on a third-party development
+using the current version of Coq (i.e., built from the current state of this
+repository).
+
+Dive into such an environment, for the project `example` by running, from the
+root of this repository:
+
+    ./dev/ci/nix/shell example
+
+This will build Coq and the other dependencies of the `example` project, then
+open a shell with all these dependencies available (e.g., `coqtop` is in path).
+
+Additionally, three environment variables are set, to abstract over the
+build-system of that project: `configure`, `make`, and `clean`. Therefore, after
+changing the working directory to the root of the sources of that project, the
+contents of these variables can be evaluated to respectively set-up, build, and
+clean the project.
-- 
cgit v1.2.3