package sturgeon
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=043a732477d2710bd55b2c004b6fce6c2fb8cbba3f9851caabcfe42b865d9926
md5=87f8441f38407fe1d941488b7d976d45
README.md.html
Sturgeon — A toolkit for communicating with Emacs
%%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>
Installation
sturgeon can be installed with opam
:
opam install sturgeon
If you don't use opam
consult the opam
file for build instructions.
Documentation
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.
Sample programs
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.