package sturgeon

  1. Overview
  2. Docs
A toolkit for communicating with Emacs from OCaml

Install

Dune Dependency

Authors

Maintainers

Sources

v0.1.tar.gz
md5=87f8441f38407fe1d941488b7d976d45

Description

Sturgeon provides various tool to manipulates Emacs from OCaml. This is work-in-progress.

Sturgeon_sexp manipulates Emacs flavor of s-expression.

Sturgeon_session is a session-protocol implemented in Emacs and OCaml.
It enables asynchronous RPC between the two languages and referencing OCaml (resp. Emacs) closures from Emacs (resp. OCaml), etc.

Sturgeon_stui is an Inuit frontend, turning an Emacs buffer into a UI.

Sturgeon_recipes offers different rendez-vous point to connect Emacs & OCaml: client (using stdin/stdout) and server (via Unix domain socket), local and remote (over SSH).

Published: 09 Nov 2016

README

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.

Dependencies (5)

  1. inuit
  2. topkg build
  3. ocamlbuild build
  4. ocamlfind build
  5. ocaml >= "4.01.0"

Dev Dependencies

None

Used by

None

Conflicts

None

OCaml

Innovation. Community. Security.