Skip to content
Browse files

Add README file

  • Loading branch information...
1 parent db12496 commit b7fec0f22ace92b1fe77318de7fded89fb6b66b4 @andrenth committed Sep 20, 2012
Showing with 27 additions and 0 deletions.
  1. +27 −0 README.md
View
27 README.md
@@ -0,0 +1,27 @@
+# OCaml-Milter
+
+## Introduction
+
+This library provides OCaml bindings to [libmilter](https://www.milter.org/).
+
+## Build and installation
+
+After cloning the repository, run the commands below to build OCaml-Milter.
+
+ $ ocaml setup.ml -configure
+ $ ocaml setup.ml -build
+
+Documentation can be generated with the command below.
+
+ $ ocaml setup.ml -doc
+
+To install OCaml-Milter, run
+
+ # ocaml setup.ml -install
+
+## Limitations
+
+Since libmilter uses pthreads internally, this module is thread-safe. However,
+due to the current OCaml implementation, each of the milter callbacks must
+acquire a global runtime lock while being executed, meaning that effectively
+only a single thread will be running at a given time.

0 comments on commit b7fec0f

Please sign in to comment.
Something went wrong with that request. Please try again.