Skip to content

Commit

Permalink
Fix the build instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
pi8027 committed Jun 20, 2024
1 parent 2a4f431 commit 830f22e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,25 +68,15 @@ slices in the input.
- [A bargain for mergesorts (functional pearl) — How to prove your mergesort correct and stable, almost for free](https://arxiv.org/abs/2403.08173) doi:[10.48550/arXiv.2403.08173](https://doi.org/10.48550/arXiv.2403.08173)

## Building and installation instructions

The easiest way to install the latest released version of Stable sort algorithms in Coq
is via [OPAM](https://opam.ocaml.org/doc/Install.html):

```shell
opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq-stablesort
```

To instead build and install manually, do:

``` shell
git clone https://github.com/pi8027/stablesort.git
cd stablesort
make # or make -j <number-of-cores-on-your-machine>
make install
opam repo add coq-released https://coq.inria.fr/opam/released
opam install ./coq-stablesort.opam
```


## Credits
The mergesort functions and the stability proofs provided in this library are
mostly based on ones in the `path` library of Mathematical Components.
11 changes: 11 additions & 0 deletions meta.yml
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,17 @@ action_appendix: |2-
env:
OPAMWITHTEST: true
build: |-
## Building and installation instructions
The easiest way to install the latest released version of Stable sort algorithms in Coq
is via [OPAM](https://opam.ocaml.org/doc/Install.html):
``` shell
git clone https://github.com/pi8027/stablesort.git
cd stablesort
opam repo add coq-released https://coq.inria.fr/opam/released
opam install ./coq-stablesort.opam
```
documentation: |-
## Credits
The mergesort functions and the stability proofs provided in this library are
Expand Down

0 comments on commit 830f22e

Please sign in to comment.