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