File: README

package info (click to toggle)
uuidm 0.9.5-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, stretch
  • size: 392 kB
  • ctags: 642
  • sloc: ml: 5,854; makefile: 25
file content (60 lines) | stat: -rw-r--r-- 1,840 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
48
49
50
51
52
53
54
55
56
57
58
59
60
-------------------------------------------------------------------------------
Uuidm - Universally unique identifiers (UUIDs) for OCaml
        Release 0.9.5
-------------------------------------------------------------------------------

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.

Uuidm is made of a single, independent, module and distributed under
the BSD3 license. 

Home page: http://erratique.ch/software/uuidm
Contact: Daniel B├╝nzli <daniel.buenzli at erratique.ch>


Installation
------------

To install Uuidm you need at least : 

    OCaml >= 3.10.0  

If you have `findlib`, it can be installed by typing :

    ocaml setup.ml -configure
    ocaml setup.ml -build 
    ocaml setup.ml -install

If you don't, `uuidm.mli` and `uuidm.ml` contain everything, the
code, the documentation and the license. Install the dependencies and
use the sources the way you want. For example if you use `ocamlbuild`
you can issue the following commands from the root directory of your
project :

    ln -s /path/to/uuidm-0.9.5/src uuidm
    echo "<uuidm> : include" >> _tags


Documentation
-------------

The documentation and API reference is automatically generated by
`ocamldoc` from `uuidm.mli`. For you convenience you can find a
generated version in the `doc` directory of the distribution.


Sample programs
---------------

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

    ocamlbuild 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`.