Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions .github/workflows/docker-action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ jobs:
strategy:
matrix:
image:
- 'rocq/rocq-prover:dev'
- 'coqorg/coq:8.19'
- 'coqorg/coq:8.18'
- 'coqorg/coq:8.17'
Expand All @@ -28,9 +27,11 @@ jobs:
- 'coqorg/coq:8.14'
- 'coqorg/coq:8.13'
- 'coqorg/coq:8.12'
- 'rocq/rocq-prover:dev'
- 'rocq/rocq-prover:9.0'
fail-fast: false
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: coq-community/docker-coq-action@v1
with:
opam_file: 'coq-huffman.opam'
Expand Down
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ Follow the instructions on https://github.com/coq-community/templates to regener
[![Contributing][contributing-shield]][contributing-link]
[![Code of Conduct][conduct-shield]][conduct-link]
[![Zulip][zulip-shield]][zulip-link]
[![coqdoc][coqdoc-shield]][coqdoc-link]

[docker-action-shield]: https://github.com/coq-community/huffman/actions/workflows/docker-action.yml/badge.svg?branch=master
[docker-action-link]: https://github.com/coq-community/huffman/actions/workflows/docker-action.yml
[docker-action-shield]: https://github.com/rocq-community/huffman/actions/workflows/docker-action.yml/badge.svg?branch=master
[docker-action-link]: https://github.com/rocq-community/huffman/actions/workflows/docker-action.yml

[contributing-shield]: https://img.shields.io/badge/contributions-welcome-%23f7931e.svg
[contributing-link]: https://github.com/coq-community/manifesto/blob/master/CONTRIBUTING.md
Expand All @@ -22,11 +21,9 @@ Follow the instructions on https://github.com/coq-community/templates to regener
[zulip-shield]: https://img.shields.io/badge/chat-on%20zulip-%23c1272d.svg
[zulip-link]: https://coq.zulipchat.com/#narrow/stream/237663-coq-community-devs.20.26.20users

[coqdoc-shield]: https://img.shields.io/badge/docs-coqdoc-blue.svg
[coqdoc-link]: https://coq-community.org/huffman/docs/latest/coqdoc/toc.html


This projects contains a Coq proof of the correctness of the Huffman coding algorithm,
This projects contains a Rocq proof of the correctness of the Huffman coding algorithm,
as described in David A. Huffman's paper A Method for the Construction of Minimum-Redundancy
Codes, Proc. IRE, pp. 1098-1101, September 1952.

Expand All @@ -35,12 +32,12 @@ Codes, Proc. IRE, pp. 1098-1101, September 1952.
- Author(s):
- Laurent Théry (initial)
- Karl Palmskog [<img src="https://zenodo.org/static/images/orcid.svg" height="14px" alt="ORCID logo" />](https://orcid.org/0000-0003-0228-1240)
- Coq-community maintainer(s):
- Rocq-community maintainer(s):
- Karl Palmskog ([**@palmskog**](https://github.com/palmskog))
- License: [GNU Lesser General Public License v2.1 or later](LICENSE)
- Compatible Coq versions: 8.12 or later
- Compatible Rocq/Coq versions: 8.12 or later
- Additional dependencies: none
- Coq namespace: `Huffman`
- Rocq/Coq namespace: `Huffman`
- Related publication(s):
- [Formalising Huffman's algorithm](https://hal.archives-ouvertes.fr/hal-02149909)
- [A Method for the Construction of Minimum-Redundancy Codes](http://compression.ru/download/articles/huff/huffman_1952_minimum-redundancy-codes.pdf) doi:[10.1109/JRPROC.1952.273898](https://doi.org/10.1109/JRPROC.1952.273898)
Expand All @@ -58,7 +55,7 @@ opam install coq-huffman
To instead build and install manually, do:

``` shell
git clone https://github.com/coq-community/huffman.git
git clone https://github.com/rocq-community/huffman.git
cd huffman
make # or make -j <number-of-cores-on-your-machine>
make install
Expand Down Expand Up @@ -99,4 +96,3 @@ decode code c;;
```

[techreport]: https://hal.archives-ouvertes.fr/hal-02149909
[coqdoc]: https://coq-community.org/huffman/docs/latest/coqdoc/toc.html
17 changes: 8 additions & 9 deletions coq-huffman.opam
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,21 @@ opam-version: "2.0"
maintainer: "[email protected]"
version: "dev"

homepage: "https://github.com/coq-community/huffman"
dev-repo: "git+https://github.com/coq-community/huffman.git"
bug-reports: "https://github.com/coq-community/huffman/issues"
doc: "https://coq-community.github.io/huffman/"
homepage: "https://github.com/rocq-community/huffman"
dev-repo: "git+https://github.com/rocq-community/huffman.git"
bug-reports: "https://github.com/rocq-community/huffman/issues"
license: "LGPL-2.1-or-later"

synopsis: "Coq proof of the correctness of the Huffman coding algorithm"
synopsis: "Rocq proof of the correctness of the Huffman coding algorithm"
description: """
This projects contains a Coq proof of the correctness of the Huffman coding algorithm,
This projects contains a Rocq proof of the correctness of the Huffman coding algorithm,
as described in David A. Huffman's paper A Method for the Construction of Minimum-Redundancy
Codes, Proc. IRE, pp. 1098-1101, September 1952."""

build: ["dune" "build" "-p" name "-j" jobs]
build: [make "-j%{jobs}%"]
install: [make "install"]
depends: [
"dune" {>= "3.5"}
"coq" {(>= "8.12" & < "8.20~") | (= "dev")}
"coq" {(>= "8.12" & <= "9.1~") | (= "dev")}
]

tags: [
Expand Down
16 changes: 8 additions & 8 deletions meta.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
---
fullname: Huffman
shortname: huffman
organization: coq-community
organization: rocq-community
community: true
action: true
coqdoc: true
coqdoc_index: 'docs/latest/coqdoc/toc.html'
coqdoc: false

synopsis: Coq proof of the correctness of the Huffman coding algorithm
synopsis: Rocq proof of the correctness of the Huffman coding algorithm

description: |-
This projects contains a Coq proof of the correctness of the Huffman coding algorithm,
This projects contains a Rocq proof of the correctness of the Huffman coding algorithm,
as described in David A. Huffman's paper A Method for the Construction of Minimum-Redundancy
Codes, Proc. IRE, pp. 1098-1101, September 1952.

Expand Down Expand Up @@ -41,10 +40,12 @@ license:

supported_coq_versions:
text: 8.12 or later
opam: '{(>= "8.12" & < "8.20~") | (= "dev")}'
opam: '{(>= "8.12" & <= "9.1~") | (= "dev")}'

tested_coq_opam_versions:
tested_rocq_opam_versions:
- version: 'dev'
- version: '9.0'
tested_coq_opam_versions:
- version: '8.19'
- version: '8.18'
- version: '8.17'
Expand Down Expand Up @@ -102,5 +103,4 @@ documentation: |-
```

[techreport]: https://hal.archives-ouvertes.fr/hal-02149909
[coqdoc]: https://coq-community.org/huffman/docs/latest/coqdoc/toc.html
---
Loading