Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 844 Bytes

README.md

File metadata and controls

38 lines (25 loc) · 844 Bytes

Noise Socket

This library implements the NoiseSocket specification using the noise library.

Installation

noise-socket can be installed via opam:

opam install noise-socket

Building

To build from source, generate documentation, and run tests, use dune:

dune build
dune build @doc
dune runtest

In addition, the following Makefile targets are available as a shorthand for the above:

make all
make build
make doc
make test

Documentation

The documentation and API reference is generated from the source interfaces. It can be consulted online or via odig:

odig odoc noise-socket
odig doc noise-socket