Skip to content

Commit

Permalink
Update meta.yml and README
Browse files Browse the repository at this point in the history
  • Loading branch information
pi8027 committed Apr 21, 2021
1 parent 2951de1 commit fd5b9bf
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docker-action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- uses: actions/checkout@v2
- uses: coq-community/docker-coq-action@v1
with:
opam_file: 'coq-mczify.opam'
opam_file: 'coq-mathcomp-zify.opam'
custom_image: ${{ matrix.image }}

# See also:
Expand Down
52 changes: 48 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,50 @@
# mczify
<!---
This file was generated from `meta.yml`, please do not edit manually.
Follow the instructions on https://github.com/coq-community/templates to regenerate.
--->
# Mczify

[![Docker CI][docker-action-shield]][docker-action-link]

[docker-action-shield]: https://github.com/math-comp/mczify/workflows/Docker%20CI/badge.svg?branch=master
[docker-action-link]: https://github.com/math-comp/mczify/actions?query=workflow:"Docker%20CI"




This small library enables the use of the Micromega tactics for goals stated
with the definitions of the Mathematical Components library by extending the
zify tactic.

## Meta

- Author(s):
- Kazuhiko Sakaguchi (initial)
- License: [CeCILL-B Free Software License Agreement](CeCILL-B)
- Compatible Coq versions: 8.13 or later
- Additional dependencies:
- [MathComp](https://math-comp.github.io) 1.12.0 or later
- Coq namespace: `mathcomp.zify`
- Related publication(s): none

## Building and installation instructions

The easiest way to install the latest released version of Mczify
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-mathcomp-zify
```

To instead build and install manually, do:

``` shell
git clone https://github.com/math-comp/mczify.git
cd mczify
make # or make -j <number-of-cores-on-your-machine>
make install
```


## Requirements

- Coq 8.13 or later, and
- Mathematical Components 1.12.0 or later.
File renamed without changes.
3 changes: 2 additions & 1 deletion meta.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
fullname: mczify
fullname: Mczify
shortname: mczify
opam_name: coq-mathcomp-zify
organization: math-comp
action: true

Expand Down

0 comments on commit fd5b9bf

Please sign in to comment.