File: README.md

package info (click to toggle)
uuidm 0.9.6-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 148 kB
  • sloc: ml: 386; makefile: 39
file content (47 lines) | stat: -rw-r--r-- 1,422 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Uuidm — Universally unique identifiers (UUIDs) for OCaml
-------------------------------------------------------------------------------
v0.9.6

Uuidm is an OCaml module implementing 128 bits universally unique
identifiers version 3, 5 (named based with MD5, SHA-1 hashing) and 4
(random based) according to [RFC 4122][rfc4122].

Uuidm has no dependency and is distributed under the ISC license.

[rfc4122]: http://tools.ietf.org/html/rfc4122

Homepage: http://erratique.ch/software/uuidm  

## Installation

Uuidm can be installed with `opam`:

    opam install uuidm

If you don't use `opam` consult the [`opam`](opam) file for build
instructions.


## Documentation

The documentation and API reference is automatically generated by
from the source interfaces. It can be consulted [online][doc].

[doc]: http://erratique.ch/software/uuidm/doc/Uuidm


## Sample programs

If you installed Uuidm with `opam`, it installed the `uuidtrip` binary
that output UUIDs; invoke with `-help` for more information.

In the distribution sample programs are located in the `test`
directory of the distribution. They can be built with:

    ocamlbuild -use-ocamlfind test/tests.otarget

The resulting binaries are in `_build/test`:

- `test.native` tests the library, nothing should fail.
- `perf.native` tests the performance of the library, see `perf.native -help`.
- `uuidtrip.native` outputs UUIDs, see `uuidtrip.native -help`.