Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the build instruction #26

Merged
merged 1 commit into from
Jun 20, 2024
Merged

Fix the build instruction #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions README.md
View file
Open in desktop
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
The easiest way to install the development 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
View file
Open in desktop
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 development 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
Loading