rocq-prover / rocq

# The Rocq Prover
[![GitLab CI][gitlab-badge]][gitlab-link]
[![GitHub CI][gh-badge]][gh-link]
[![Zulip][zulip-badge]][zulip-link]
[![Discourse][discourse-badge]][discourse-link]
[![DOI][doi-badge]][doi-link]
[gitlab-badge]: https://gitlab.inria.fr/coq/coq/badges/master/pipeline.svg
[gitlab-link]: https://gitlab.inria.fr/coq/coq/commits/master
[gh-badge]: https://github.com/rocq-prover/rocq/actions/workflows/ci-github.yml/badge.svg
[gh-link]: https://github.com/rocq-prover/rocq/actions/workflows/ci-github.yml
[discourse-badge]: https://img.shields.io/badge/Discourse-forum-informational.svg
[discourse-link]: https://discourse.rocq-prover.org/
[zulip-badge]: https://img.shields.io/badge/Zulip-chat-informational.svg
[zulip-link]: https://rocq-prover.zulipchat.com/
[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.15149628.svg
[doi-link]: https://doi.org/10.5281/zenodo.15149628
The Rocq Prover is an interactive theorem prover, or proof assistant. It provides a formal language to write
mathematical definitions, executable algorithms and theorems together with an
environment for semi-interactive development of machine-checked proofs.
## Installation
[![latest packaged version(s)][repology-badge]][repology-link]
[![Docker Hub package][dockerhub-badge]][dockerhub-link]
[![latest dockerized version][docker-rocq-badge]][docker-rocq-link]
[repology-badge]: https://repology.org/badge/latest-versions/coq.svg
[repology-link]: https://repology.org/metapackage/coq/versions
[dockerhub-badge]: https://img.shields.io/badge/images%20on-Docker%20Hub-blue.svg
[dockerhub-link]: https://hub.docker.com/r/rocq/rocq-prover#supported-tags "Supported tags on Docker Hub"
[docker-rocq-badge]: https://img.shields.io/docker/v/rocq/rocq-prover/latest
[docker-rocq-link]: https://github.com/rocq-community/docker-coq/wiki#docker-coq-images "rocq/rocq-prover:latest"
Please see https://rocq-prover.org/install.
Information on how to build and install from sources can be found in
`INSTALL.md`.
## Documentation
The sources of the documentation can be found in directory `doc`.
See `doc/README.md` to learn more about the documentation,
in particular how to build it. The
documentation of the last released version is available on the Rocq
web site at rocq-prover.org/docs.
See also the Rocq wiki,
and the Rocq FAQ,
for additional user-contributed documentation.
The documentation of the master branch is continuously deployed. See:
- [Reference Manual (master)][refman-master]
- [Documentation of the standard library (master)][stdlib-master]
- [Documentation of the ML API (master)][api-master]
[api-master]: https://rocq-prover.org/doc/master/api/
[refman-master]: https://rocq-prover.org/doc/master/refman/
[stdlib-master]: https://rocq-prover.org/doc/master/stdlib/
## Changes
The Recent
changes chapter
of the reference manual explains the differences and the
incompatibilities of each new version of the Rocq Prover. If you upgrade Rocq,
please read it carefully as it contains important advice