Page
Library
Module
Module type
Parameter
Class
Class type
Source
%%VERSION%%
sturgeon is TODO
sturgeon is distributed under the ISC license.
Homepage: https://github.com/let-def/sturgeon Contact: Frédéric Bour <frederic.bour@lakaban.net>
sturgeon can be installed with opam
:
opam install sturgeon
If you don't use opam
consult the opam
file for build instructions.
The documentation and API reference is automatically generated by ocamldoc
from the interfaces. It can be consulted online and there is a generated version in the doc
directory of the distribution.
If you installed sturgeon with opam
sample programs are located in the directory opam config var sturgeon:doc
.
In the distribution sample programs and tests 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.