Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 2.24 KB

README.md

File metadata and controls

78 lines (52 loc) · 2.24 KB
Raw

Calendar

A calendar library for OCaml. API documentation

Travis build Status

  1. Introduction
  2. Contents
  3. Copyright
  4. Installation
  5. How to use
  6. Documentation
  7. Makefile
  8. Contact the developers

1- Introduction

The Calendar library provides types and operations over dates and times. This library requires OCaml 4.03.0 or higher. Older OCaml versions are unsupported.

2- Contents

  • CHANGES Information about the last changes
  • COPYING Information about copyright
  • LGPL Information about LGPL
  • README.md This file
  • calendar_faq.txt FAQ frow which some algorithms come
  • doc HTML documentation of the API
  • src Source files directory
  • _build/default/ Directory containing the built library
  • tests Test files directory
  • utils Some utilities

3- Copyright

This program is distributed under the GNU LGPL 2.1. See the enclosed file COPYING for more details.

4- Installation

Easiest way is opam install calendar.

To manually install the library, you first need to install dune and re. Then:

$ dune build @install
$ dune install

You can remove files installed with :

dune uninstall

5- How to use

Use the calendar library using ocamlfind. In dune, it means having an entry (libraries calendar).

6- Documentation

The doc directory contains an html documentation of the .mli files. This documentation is available online at http://calendar.forge.ocamlcore.org/doc/

7- Makefile

A description of some Makefile entries follows :

  • make test will execute some tests. You'll need alcotest.

    To run only some tests: dune exec ./tests/test.exe test time (for example)

  • make doc to produce the documentation of the API. You need odoc

8- Contact the developers

You can report bugs at https://github.com/ocaml-community/calendar/issues