summaryrefslogtreecommitdiff
path: root/README.md
blob: dae89ead2b6285ec630076627bfcdd2e125cd050 (plain)
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
Ptime — POSIX time for OCaml
============================
v1.0.0

Ptime has platform independent POSIX time support in pure OCaml. It
provides a type to represent a well-defined range of POSIX timestamps
with picosecond precision, conversion with date-time values,
conversion with [RFC 3339 timestamps][rfc3339] and pretty printing to
a human-readable, locale-independent representation.

The additional Ptime_clock library provides access to a system POSIX
clock and to the system's current time zone offset.

Ptime is not a calendar library.

Ptime has no dependency. Ptime_clock depends on your system library or
JavaScript runtime system. Ptime and its libraries are distributed
under the ISC license.

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

Home page: http://erratique.ch/software/ptime  

# Installation

Ptime can be installed with `opam`:

    opam install ptime

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

# Documentation

The documentation and API reference is generated from the source
interfaces. It can be consulted [online][doc] or via `odig doc ptime`.

[doc]: http://erratique.ch/software/ptime/doc/

# Sample programs

If you installed Ptime with `opam` sample programs are located in
the directory `opam config var ptime:doc`.