README.md 1.34 KB
Newer Older
Ralf Jung's avatar
Ralf Jung committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# PREREQUISITES

This version is known to compile with:

 - Coq 8.5
 - Ssreflect 1.6

For development, better make sure you have a version of Ssreflect that includes
commit be724937 (no such version has been released so far, you will have to
fetch the development branch yourself). Iris compiles fine even without this
patch, but proof bullets will only be in 'strict' (enforcing) mode with the
fixed version of Ssreflect.
 
# BUILDING INSTRUCTIONS

Run the following command to build the full development:

Ralf Jung's avatar
Ralf Jung committed
18
    make
Ralf Jung's avatar
Ralf Jung committed
19

20
The development can then be installed as the Coq user contribution `iris` by
21 22 23
running:

    make install
Ralf Jung's avatar
Ralf Jung committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37

# STRUCTURE

* The folder `prelude` contains an extended "Standard Library" by Robbert
  Krebbers <http://robbertkrebbers.nl/thesis.html>.
* The folder `algebra` contains the COFE and CMRA constructions as well as
  the solver for recursive domain equations.
* The folder `program_logic` builds the semantic domain of Iris, defines and
  verifies primitive view shifts and weakest preconditions, and builds some
  language-independent derived constructions (e.g., STSs).
* The folder `heap_lang` defines the ML-like concurrent heap language, and a
  few derived constructions (e.g., parallel composition).
* The folder `barrier` contains the implementation and proof of the barrier.
* The folder `examples` contains the examples given in the paper.