tiny_httpd/hmap/_doc-dir/README.md
2024-03-07 02:28:50 +00:00

43 lines
1.2 KiB
Markdown

Hmap — Heterogeneous value maps for OCaml
-------------------------------------------------------------------------------
v0.8.1
Hmap provides heterogeneous value maps for OCaml. These maps bind keys
to values with arbitrary types. Keys witness the type of the value
they are bound to which allows to add and lookup bindings in a type
safe manner.
Hmap has no dependency and is distributed under the ISC license.
Home page: http://erratique.ch/software/hmap
Contact: Daniel Bünzli `<daniel.buenzl i@erratique.ch>`
## Installation
Hmap can be installed with `opam`:
opam install hmap
If you don't use `opam` consult the [`opam`](opam) file for build
instructions.
## Documentation
The documentation and API reference is automatically generated by
`ocamldoc` from the interfaces. It can be consulted [online][doc]
and there is a generated version in the `doc` directory of the
distribution.
[doc]: http://erratique.ch/software/hmap/doc
## Sample programs
If you installed Hmap with `opam` sample programs are located in
the directory `opam config var hmap:doc`.
In the distribution sample programs and tests are located in the
[`test`](test) directory of the distribution. They can be built an run
with
topkg build --tests true
topkg test