this repo has no description
anil.recoil.org
1opam-version: "2.0"
2maintainer: "Romain Calascibetta <romain.calascibetta@gmail.com>"
3authors: "Romain Calascibetta <romain.calascibetta@gmail.com>"
4homepage: "https://github.com/mirage/decompress"
5bug-reports: "https://github.com/mirage/decompress/issues"
6dev-repo: "git+https://github.com/mirage/decompress.git"
7doc: "https://mirage.github.io/decompress/"
8license: "MIT"
9
10build: [
11 [
12 "jbuilder"
13 "build"
14 "--only-packages"
15 name
16 "--no-config" {jbuilder:version >= "1.0+beta18"}
17 "--root"
18 "."
19 "-j"
20 jobs
21 "@install"
22 ]
23 [
24 "jbuilder"
25 "build"
26 "--only-packages"
27 name
28 "--no-config" {jbuilder:version >= "1.0+beta18"}
29 "--root"
30 "."
31 "-j"
32 jobs
33 "@runtest"
34 ] {with-test & ocaml:version < "4.08.0"}
35]
36depends: [
37 "ocaml" {>= "4.03.0"}
38 "jbuilder"
39 "base-bytes"
40 "optint"
41 "checkseum"
42 "camlzip" {with-test & >= "1.07"}
43 "re" {with-test & >= "1.7.2"}
44 "alcotest" {with-test}
45 "cmdliner"
46]
47synopsis: "Pure OCaml implementation of Zlib"
48description: """
49[](https://travis-ci.org/mirage/decompress)
50
51
52Decompress is a pure implementation of `zlib`. The goal is to create an
53available package for Mirage OS for `zlib` in OCaml (instead a C code).
54
55We respect the interface of `zlib` and all flush mode is available
56(experimental):
57
58- `SYNC_FLUSH`
59- `PARTIAL_FLUSH`
60- `FULL_FLUSH`
61
62The interface proposed is a non-blocking interface.
63
64
65Documentation: https://mirage.github.io/decompress/api.docdir/
66
67
68## Installation
69
70Decompress can be installed with `opam`:
71
72 opam install decompress
73
74## Sample programs
75
76Sample program are located in the `bin` directory of the distribution. It can be
77built with (dependancy with Unix module, the `cmdliner` package and a C code):
78
79 ocamlbuild -use-ocamlfind bin/dpipe.native
80
81Another good example is provided in `bin/easy.ml` with the signature:
82
83```ocaml
84val compress : ?level:int -> string -> string
85val uncompress : string -> string
86```
87
88And you can compile this program with:
89
90 ocamlbuild -use-ocamlfind bin/easy.native
91
92But keep in your mind, it's an easy example and it's not optimized for a
93productive environment - so, don't copy/paste and think.
94
95The documentation is
96available [online](https://mirage.github.io/decompress/api.docdir/) to
97understand how to use Decompress.
98
99## Build Requirements
100
101 * OCaml >= 4.03.0
102 * `base-bytes` meta-package
103 * Bigarray module (provided by the standard library of OCaml)
104 * `topkg`, `ocamlfind` and `ocamlbuild` to build the project
105
106If you want to compile the test program, you need:
107
108 * `camlzip` to compare `decompress` with `zlib`
109 * `re.1.7.1`
110 * `alcotest`"""
111url {
112 src:
113 "https://github.com/mirage/decompress/releases/download/v0.8/decompress-0.8.tbz"
114 checksum: [
115 "sha256=ea6987f72816044ccf3edb586e3b64668d53c5ef1b0a735119e5c9d740504240"
116 "md5=547eaf0803af3ed01ff7801facfe27e6"
117 ]
118}
119available: [ arch != "s390x" ]