Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
I
iris-coq
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Michael Sammler
iris-coq
Commits
9f126450
Commit
9f126450
authored
6 years ago
by
Ralf Jung
Browse files
Options
Downloads
Patches
Plain Diff
improve README structure
parent
27914f3f
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+18
-4
18 additions, 4 deletions
README.md
with
18 additions
and
4 deletions
README.md
+
18
−
4
View file @
9f126450
...
@@ -3,7 +3,9 @@
...
@@ -3,7 +3,9 @@
This is the Coq development of the
[
Iris Project
](
http://iris-project.org
)
, in
This is the Coq development of the
[
Iris Project
](
http://iris-project.org
)
, in
the MoSeL version.
the MoSeL version.
## Prerequisites
## Building Iris
### Prerequisites
This version is known to compile with:
This version is known to compile with:
...
@@ -15,7 +17,7 @@ For a version compatible with Coq 8.6, have a look at the
...
@@ -15,7 +17,7 @@ For a version compatible with Coq 8.6, have a look at the
If you need to work with Coq 8.5, please check out the
If you need to work with Coq 8.5, please check out the
[
iris-3.0 branch
](
https://gitlab.mpi-sws.org/FP/iris-coq/tree/iris-3.0
)
.
[
iris-3.0 branch
](
https://gitlab.mpi-sws.org/FP/iris-coq/tree/iris-3.0
)
.
## Installing via opam
##
#
Installing via opam
To obtain the latest stable release via opam (1.2.2 or newer), you have to add
To obtain the latest stable release via opam (1.2.2 or newer), you have to add
the Coq opam repository:
the Coq opam repository:
...
@@ -28,7 +30,7 @@ To obtain a development version, add the Iris opam repository:
...
@@ -28,7 +30,7 @@ To obtain a development version, add the Iris opam repository:
opam repo add iris-dev https://gitlab.mpi-sws.org/FP/opam-dev.git
opam repo add iris-dev https://gitlab.mpi-sws.org/FP/opam-dev.git
## Building from source
##
#
Building from source
When building Iris from source, we recommend to use opam (1.2.2 or newer) for
When building Iris from source, we recommend to use opam (1.2.2 or newer) for
installing Iris's dependencies. This requires the following two repositories:
installing Iris's dependencies. This requires the following two repositories:
...
@@ -98,7 +100,9 @@ that should be compatible with this version:
...
@@ -98,7 +100,9 @@ that should be compatible with this version:
*
[
Iris Atomic
](
https://gitlab.mpi-sws.org/FP/iris-atomic/
)
is an experimental
*
[
Iris Atomic
](
https://gitlab.mpi-sws.org/FP/iris-atomic/
)
is an experimental
formalization of logically atomic triples in Iris.
formalization of logically atomic triples in Iris.
## For Developers: How to update the std++ dependency
## Notes for Iris Developers
### How to update the std++ dependency
*
Do the change in std++, push it.
*
Do the change in std++, push it.
*
Wait for CI to publish a new std++ version on the opam archive, then run
*
Wait for CI to publish a new std++ version on the opam archive, then run
...
@@ -107,3 +111,13 @@ that should be compatible with this version:
...
@@ -107,3 +111,13 @@ that should be compatible with this version:
*
Run
`make build-dep`
(in Iris) to install the new version of std++.
*
Run
`make build-dep`
(in Iris) to install the new version of std++.
You may have to do
`make clean`
as Coq will likely complain about .vo file
You may have to do
`make clean`
as Coq will likely complain about .vo file
mismatches.
mismatches.
### How to write/update test cases
The files in
`tests/`
are test cases. Each of the
`.v`
files comes with a
matching
`.ref`
file containing the expected output of
`coqc`
. Adding
`Show.`
in selected places in the proofs makes
`coqc`
print the current goal state.
This is used to make sure the proof mode prints goals and reduces terms the way
we expect it to. You can run
`make ref`
to re-generate all the
`.ref`
files;
this is useful after adding or removing
`Show.`
from a test. If you do this,
make sure to check the diff for any unexpected changes in the output!
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment