use submodules to document matching Iris version

.gitignore

@@ -10,4 +10,5 @@
 *.bak
 Makefile.coq
 .coq-native/
+iris-enabled
 

.gitmodules

+[submodule "iris"]
+	path = iris
+	url = https://gitlab.mpi-sws.org/FP/iris-coq.git

Makefile

-# Makefile originally taken from coq-club
-
-%: Makefile.coq
-	+make -f Makefile.coq $@
+%: Makefile.coq phony
+	+@make -f Makefile.coq $@
 
 all: Makefile.coq
-	+make -f Makefile.coq all
+	+@make -f Makefile.coq all
 
 clean: Makefile.coq
-	+make -f Makefile.coq clean
+	+@make -f Makefile.coq clean
 	rm -f Makefile.coq
 
 Makefile.coq: _CoqProject Makefile
 	coq_makefile -f _CoqProject | sed 's/$$(COQCHK) $$(COQCHKFLAGS) $$(COQLIBS)/$$(COQCHK) $$(COQCHKFLAGS) $$(subst -Q,-R,$$(COQLIBS))/' > Makefile.coq
 
+iris-local: clean
+	git submodule update --init iris
+	ln -nsf iris iris-enabled
+	+make -C iris -f Makefile
+
+iris-system: clean
+	rm -f iris-enabled
+
 _CoqProject: ;
 
 Makefile: ;
 
-.PHONY: all clean
+phony: ;
+
+.PHONY: all clean phony iris-local iris-system

README.md

-iris-atomic
-====
+# IRIS-ATOMIC
 
 Atomicity related verification based on Iris logic.
 
-Build
---------
+## Prerequisites
 
-Please make sure Iris dependency version is same as noted in `IRIS_VERSION`
+This version is known to compile with:
+
+ - Coq 8.5pl2
+ - Ssreflect 1.6
+
+You will furthermore need an up-to-date version of
+[Iris](https://gitlab.mpi-sws.org/FP/iris-coq/).  Run `git submodule status` to
+see which git commit of Iris is known to work.  You can pick between using a
+system-installed Iris (from Coq's `user-contrib`) or a version of Iris locally
+compiled for lambda-Rust.
+
+## Building Instructions
+
+To use the system-installed Iris (which is the default), run `make iris-system`.
+This only works if you previously built and installed a compatible version of the
+Iris Coq formalization.  To use a local Iris (which will always be the right
+version), run `make iris-local`.  Run this command again later to update the
+local Iris, in case the preferred Iris version changed.
+
+Now run `make` to build the full development.

_CoqProject

--Q . iris_atomic
-atomic.v
-sync.v
-atomic_incr.v
-simple_sync.v
-flat.v
-atomic_sync.v
-treiber.v
-misc.v
-evmap.v
-peritem.v
-atomic_pcas.v
+-Q theories iris_atomic
+-Q iris-enabled iris
+theories/atomic.v
+theories/sync.v
+theories/atomic_incr.v
+theories/simple_sync.v
+theories/flat.v
+theories/atomic_sync.v
+theories/treiber.v
+theories/misc.v
+theories/evmap.v
+theories/peritem.v
+theories/atomic_pcas.v

iris @ 6cb76aaa

+Subproject commit 6cb76aaaf15d46c74c2a779f1e4e1ca1a53c0838