Browse files

Add README file

  • Loading branch information...
1 parent cef6534 commit 466ebb649592702accbbf66d4957713eb723fea3 @andrenth committed Sep 20, 2012
Showing with 26 additions and 0 deletions.
  1. +26 −0 README.md
View
26 README.md
@@ -0,0 +1,26 @@
+# OCaml-SPF
+
+## Introduction
+
+This library provides OCaml bindings to [libspf2](http://www.libspf2.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-SPF, run
+
+ # ocaml setup.ml -install
+
+## Notes
+
+It is strongly recommended that a [patched libspf2 with fixes collected from
+the SPF-devel mailing list](https://github.com/andrenth/libspf2) is used
+instead of the current official libspf2 release (version 1.2.9).

0 comments on commit 466ebb6

Please sign in to comment.