Commit 14ac28b1 authored by Ralf Jung's avatar Ralf Jung

move docs around

parent e8f260ef
# Contributing to the Iris Coq Development # Contributing to the Iris Coq Development
Here you can find some how-tos for various thing sthat might come up when doing Here you can find some how-tos for various thing sthat might come up when doing
Iris development. Iris development. This is for contributing to Iris itself; see
[the README](README.md#further-resources) for resources helpful for all Iris
users.
## How to submit a merge request ## How to submit a merge request
......
This diff is collapsed.
...@@ -9,7 +9,7 @@ For using the Coq library, check out the ...@@ -9,7 +9,7 @@ For using the Coq library, check out the
For understanding the theory of Iris, a LaTeX version of the core logic For understanding the theory of Iris, a LaTeX version of the core logic
definitions and some derived forms is available in definitions and some derived forms is available in
[docs/iris.tex](docs/iris.tex). A compiled PDF version of this document is [docs/iris.tex](tex/iris.tex). A compiled PDF version of this document is
[available online](http://plv.mpi-sws.org/iris/appendix-3.2.pdf). [available online](http://plv.mpi-sws.org/iris/appendix-3.2.pdf).
## Building Iris ## Building Iris
...@@ -83,7 +83,7 @@ followed by `make build-dep`. ...@@ -83,7 +83,7 @@ followed by `make build-dep`.
[MoSeL](http://iris-project.org/mosel/), which extends Coq with contexts for [MoSeL](http://iris-project.org/mosel/), which extends Coq with contexts for
intuitionistic and spatial BI++ assertions. It also contains tactics for intuitionistic and spatial BI++ assertions. It also contains tactics for
interactive proofs. Documentation can be found in interactive proofs. Documentation can be found in
[ProofMode.md](ProofMode.md). [ProofMode.md](docs/proof_mode.md).
* The folder [heap_lang](theories/heap_lang) defines the ML-like concurrent heap * The folder [heap_lang](theories/heap_lang) defines the ML-like concurrent heap
language language
* The subfolder [lib](theories/heap_lang/lib) contains a few derived * The subfolder [lib](theories/heap_lang/lib) contains a few derived
...@@ -113,11 +113,11 @@ that should be compatible with this version: ...@@ -113,11 +113,11 @@ that should be compatible with this version:
Getting along with Iris in Coq: Getting along with Iris in Coq:
* Iris proof patterns are documented in the [proof guide](ProofGuide.md). * Iris proof patterns are documented in the [proof guide](docs/proof_guide.md).
* Syntactic conventions are described in the [style guide](StyleGuide.md). * Syntactic conventions are described in the [style guide](docs/style_guide.md).
* The Iris tactics are described in the * The Iris tactics are described in the
[the Iris Proof Mode (IPM) / MoSeL documentation](ProofMode.md) as well as the [the Iris Proof Mode (IPM) / MoSeL documentation](docs/proof_mode.md) as well as the
[HeapLang documentation](HeapLang.md). [HeapLang documentation](docs/heap_lang.md).
* The generated coqdoc is [available online](https://plv.mpi-sws.org/coqdoc/iris/). * The generated coqdoc is [available online](https://plv.mpi-sws.org/coqdoc/iris/).
Contacting the developers: Contacting the developers:
...@@ -137,7 +137,7 @@ Contacting the developers: ...@@ -137,7 +137,7 @@ Contacting the developers:
Miscellaneous: Miscellaneous:
* Information on how to set up your editor for unicode input and output is * Information on how to set up your editor for unicode input and output is
collected in [Editor.md](Editor.md). collected in [Editor.md](docs/editor.md).
* If you are writing a paper that uses Iris in one way or another, you could use * If you are writing a paper that uses Iris in one way or another, you could use
the [Iris LaTeX macros](docs/iris.sty) for typesetting the various Iris the [Iris LaTeX macros](tex/iris.sty) for typesetting the various Iris
connectives. connectives.
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment