Skip to content

Commit ce212b6

Browse files
Merge pull request #2321 from jdchristensen/install-mention-rocq
Briefly mention Rocq in INSTALL.md and fix typo
2 parents 5c938e4 + 67669e9 commit ce212b6

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

INSTALL.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ library to use in your own project or to play around with.
99
- [Source Versions](#source-versions)
1010
- [Development Versions](#development-versions)
1111
- [3. Setup for developers (using git)](#3-setup-for-developers-using-git)
12-
- [3.1. Prequisites (Installing Coq)](#31-prequisites-installing-coq)
12+
- [3.1. Prerequisites (Installing Coq)](#31-prerequisites-installing-coq)
1313
- [3.1.1. Development in OSX and Windows](#311-development-in-osx-and-windows)
1414
- [3.2. Forking and obtaining the HoTT library](#32-forking-and-obtaining-the-hott-library)
1515
- [3.3. Building the HoTT library](#33-building-the-hott-library)
@@ -21,6 +21,11 @@ library to use in your own project or to play around with.
2121

2222
# 1. Installation using Coq Platform
2323

24+
**Note:** As of version 9.0, Coq has been renamed Rocq. When you install Coq-HoTT
25+
following the instructions in this section, it should automatically
26+
install the compatibility wrappers, so that the nothing about the build process
27+
needs to change.
28+
2429
In order to install the HoTT library, we recommend that you use the [Coq
2530
Platform][1]. This will install the [Coq Proof Assistant][2] together with the
2631
HoTT library. The Coq Platform supports installation on **Linux**, **MacOS** and
@@ -63,6 +68,11 @@ From HoTT Require Import HoTT.
6368
6469
# 2. Installation of HoTT library using opam
6570

71+
**Note:** As of version 9.0, Coq has been renamed Rocq. When you install Coq-HoTT
72+
following the instructions in this section, it should automatically
73+
install the compatibility wrappers, so that the nothing about the build process
74+
needs to change.
75+
6676
## Released Versions
6777

6878
More advanced users may wish to install the HoTT library via `opam` ([See here
@@ -99,17 +109,26 @@ Then install the library with `opam install coq-hott`, as for the released versi
99109

100110
# 3. Setup for developers (using git)
101111

102-
## 3.1. Prequisites (Installing Coq)
112+
## 3.1. Prerequisites (Installing Coq)
103113

104114
We recommend that you use the `opam` package manager to install `coq`. Details
105115
about [installing Opam can be found here][3].
116+
We also recommend working within an [opam switch][20], to keep your work
117+
isolated from other packages installed via opam.
106118

107-
Using `opam` you can install the latest version of `coq` by doing the following:
119+
After setting up a switch (if you choose to do so),
120+
you can install the latest 8.x version of `coq` by doing the following:
108121

109122
```shell
110123
$ opam install coq
111124
```
112125

126+
To install the latest 9.x version of Rocq and the Coq compatibility wrappers, do
127+
128+
```shell
129+
$ opam install rocq-core coq-core
130+
```
131+
113132
You will also need `make` and `git` in a typical workflow.
114133

115134

@@ -252,3 +271,5 @@ GitHub](https://github.com/HoTT/HoTT).
252271
[17]: https://stackoverflow.com/a/54086635
253272
[18]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
254273
[19]: https://coq.inria.fr/user-interfaces.html
274+
275+
[20]: https://ocaml.org/docs/opam-switch-introduction

0 commit comments

Comments
 (0)