Skip to content

Commit 3cbd749

Browse files
README
1 parent 051c511 commit 3cbd749

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
# Iris Tutorial
2-
The Iris Tutorial is an introduction to the [Iris separation logic framework](https://iris-project.org/) and how to work with its [Coq formalization](https://gitlab.mpi-sws.org/iris/iris/).
2+
The Iris Tutorial is an introduction to the [Iris separation logic framework](https://iris-project.org/) and how to work with its [Rocq formalization](https://gitlab.mpi-sws.org/iris/iris/).
33

4-
The exposition is intended for a broad range of readers from advanced undergraduates to PhD students and researchers. We assume that readers are already motivated to learn Iris and thus present the material in a bottom-up fashion, rather than starting out with cool motivating examples. The tutorial material is intended to be self-contained. No specific background in logic or programming languages is assumed but some familiarity with basic programming languages theory and discrete mathematics will be beneficial, see e.g. [TAPL](https://www.cis.upenn.edu/~bcpierce/tapl/). Additionally, basic knowledge of the Coq proof assistant is assumed. Advanced Coq tactics have been purposefully kept to a minimum, and some proofs are longer than necessary to facilitate learning. We demonstrate more advanced tactics in chapter [ticket_lock_advanced](/theories/ticket_lock_advanced.v).
4+
The exposition is intended for a broad range of readers from advanced undergraduates to PhD students and researchers. We assume that readers are already motivated to learn Iris and thus present the material in a bottom-up fashion, rather than starting out with cool motivating examples. The tutorial material is intended to be self-contained. No specific background in logic or programming languages is assumed but some familiarity with basic programming languages theory and discrete mathematics will be beneficial, see e.g. [TAPL](https://www.cis.upenn.edu/~bcpierce/tapl/). Additionally, basic knowledge of the Rocq prover is assumed. Advanced Rocq tactics have been purposefully kept to a minimum, and some proofs are longer than necessary to facilitate learning. We demonstrate more advanced tactics in chapter [ticket_lock_advanced](/theories/ticket_lock_advanced.v).
55

66
The tutorial comes in two versions:
77

88
- The folder `exercises`: a skeleton development with exercises left admitted.
99
- The folder `theories`: the full development with solutions.
1010

11-
The tutorial consists of several chapters, each corresponding to a Coq file. The graph in [Chapter Dependencies](README.md#chapter-dependencies) illustrates possible ways to go through the tutorial. However, the recommended order is specified in the [Recommended Learning Path](README.md#recommended-learning-path).
11+
The tutorial consists of several chapters, each corresponding to a Rocq file. The graph in [Chapter Dependencies](README.md#chapter-dependencies) illustrates possible ways to go through the tutorial. However, the recommended order is specified in the [Recommended Learning Path](README.md#recommended-learning-path).
1212

1313
## Setup
1414
This version is known to compile with
1515

16-
- Coq 8.20.1
16+
- Rocq 8.20.1
1717
- Iris 4.3.0
1818

1919
The recommended way to install the dependencies is through [opam](https://opam.ocaml.org/doc/Install.html).
2020

2121
1. Install [opam](https://opam.ocaml.org/doc/Install.html) if not already installed (a version greater than 2.0 is required).
22-
2. Install a new switch and link it to the project.
22+
2. Install a new switch and link it to the project. From the root of the repository, execute
2323
```
2424
opam switch create iris_tutorial 5.2.0
2525
opam switch link iris_tutorial .
2626
```
27-
3. Add the Coq opam repository.
27+
3. Add the Rocq opam repository.
2828
```
2929
opam repo add coq-released https://coq.inria.fr/opam/released
3030
opam repo add iris-dev https://gitlab.mpi-sws.org/iris/opam.git
@@ -41,7 +41,7 @@ Iris makes extensive use of Unicode characters. [This guide](https://gitlab.mpi-
4141
## Chapter Overview
4242
- [basics](/exercises/basics.v) - Introduction to the separation
4343
logic and the Iris Proof Mode
44-
- [pure](/exercises/pure.v) - Distinction between the Coq context and the Iris context
44+
- [pure](/exercises/pure.v) - Distinction between the Rocq context and the Iris context
4545
- [lang](/exercises/lang.v) - Introduction to HeapLang
4646
- [specifications](/exercises/specifications.v) - Weakest precondition,
4747
basic resources, Hoare triples, and basic concurrency
@@ -57,7 +57,7 @@ Iris makes extensive use of Unicode characters. [This guide](https://gitlab.mpi-
5757
- [counter](/exercises/counter.v) - The authoritative camera
5858
- [spin_lock](/exercises/spin_lock.v) - Specification of a spin lock
5959
- [ticket_lock](/exercises/ticket_lock.v) - Specification of a ticket lock
60-
- [ticket_lock_advanced](/theories/ticket_lock_advanced.v) - Advanced Coq tactics
60+
- [ticket_lock_advanced](/theories/ticket_lock_advanced.v) - Advanced Rocq tactics
6161
- [adequacy](/exercises/adequacy.v) - Adequacy
6262
- [merge_sort](/exercises/merge_sort.v) - Merge sort
6363
- [custom_ra](/exercises/custom_ra.v) - Defining resource algebras from scratch
@@ -160,7 +160,7 @@ To contribute, we recommend following these steps:
160160
For more detailed instructions, see [first-contributions](
161161
https://github.com/firstcontributions/first-contributions).
162162

163-
### CoqdocJS
163+
### RocqdocJS
164164
This tutorial uses [CoqdocJS](https://github.com/coq-community/coqdocjs), so please make sure to format your changes accordingly. To see what your changes will look like in the documentation, run
165165
```
166166
git submodule update --init

0 commit comments

Comments
 (0)