README.md

Fmlib - Functional Library with Managed Effects for Ocaml

Overview

Fmlib is a functional library which has components for

• Standard Data Structures (B trees, ... ): Fmlib_std

• Pretty Printing: Fmlib_pretty

• Parsing: Fmlib_parse

• Web applications: Fmlib_browser.

• Access to the browser and nodejs: Fmlib_js.

API Documentation

• Fmlib_std

• Fmlib_pretty

• Fmlib_parse

• Fmlib_browser

• Fmlib_js

Design Documentation: Some designs and the corresponding algorithms are documented separately to ensure correctness of the corresponding designs and algorithms. The design documention is not neccessary to understand the usage of the library from a user's perspective. The user's perspective is documented in the API.

Installation

It is best to install the libraries via the ocaml package manager opam.

opam install fmlib_std
opam install fmlib_pretty
opam install fmlib_parse
opam install fmlib_browser

Usage with dune

A program foo which uses e.g. the library fmlib_std can be e.g. compiled by dune with the dune file

(executable
    (name foo)
    (libraries
        fmlib_std
        ...
    )
)