1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..5aca0e8
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+OCaml (caml.org) bindings for the Ivy library (www.tls.cena.fr/products/ivy).
+
+Two libraries are provided:
+ - ivy-ocaml, running with the Ivy main loop (module IvyLoop)
+ - glibivy-ocaml, running with the Glib main loop (provided by lablgtk)
+
+Installation:
+ - Requires the OCaml compiler and the ivy-c library
+ - "make" to compile
+ - "make install" to set the files (DESTDIR may be specified)
+ - "examples" directory contains the ivyprobe program for both main loops
+("make ivyivyprobe.out" and "make glibivyprobe.out")
+
+Documentation:
+ - The Ivy documentation (www.tls.cena.fr/products/ivy)
+ - The .mli files (ivy.mli, ivyLoop.mli and glibIvy.mli)
+
+Maintainer: Pascal Brisset (pascal dot brisset at enac dot fr)