Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mattam82 committed Jan 29, 2025
1 parent 7d0cc22 commit 2ce6d98
Showing 1 changed file with 8 additions and 20 deletions.
28 changes: 8 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3012649.svg)](https://zenodo.org/record/3012649#.XcEydZNKjOQ)
[![Zulip Chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://coq.zulipchat.com/#narrow/stream/237659-Equations-devs.20.26.20users)

Copyright 2009-2022 Matthieu Sozeau `[email protected]`
Copyright 2009-2025 Matthieu Sozeau `[email protected]`
Copyright 2015-2018 Cyprien Mangin `[email protected]`

Distributed under the terms of the GNU Lesser General Public License
Expand All @@ -27,10 +27,12 @@ definitions are axiom-free.

***Table of Contents***

- [Learning Equations](#learning-equations)
- [Documentation](#documentation)
- [Papers](#papers)
- [Gallery](examples)
- [Papers and presentations](#papers-and-presentations)
- [Installation](#installation)
- [Install with OPAM](#install-with-opam)
- [Install from source](#install-from-source)
- [HoTT Variant](#hott-variant)

## Learning Equations
Expand Down Expand Up @@ -83,15 +85,6 @@ definitions are axiom-free.

## Installation

The latest version works with Coq 8.13 (branch
[8.13](https://github.com/mattam82/Coq-Equations/tree/8.13)),
Coq 8.14 (branch
[8.14](https://github.com/mattam82/Coq-Equations/tree/8.14)),
Coq 8.15 (branch
[8.15](https://github.com/mattam82/Coq-Equations/tree/8.15)),
and the current Coq main branch (branch
[main](https://github.com/mattam82/Coq-Equations/tree/main)).

See [releases](https://github.com/mattam82/Coq-Equations/releases) for
sources and official releases.

Expand Down Expand Up @@ -122,18 +115,13 @@ Alternatively, to compile Equations, simply run:
./configure.sh
make

in the toplevel directory, with `coqc` and `ocamlc` in your path.
in the toplevel directory, with `coqc`, `ocamlc` and `dune` in your path.

Optionally, one can build the test-suite or examples:
Optionally, one can build the test-suite:

make examples test-suite

Then add the paths to your `.coqrc`:

Add ML Path "/Users/mat/research/coq/equations/src".
Add Rec LoadPath "/Users/mat/research/coq/equations/theories" as Equations.

Or install it:
Then install it:

make install

Expand Down

0 comments on commit 2ce6d98

Please sign in to comment.