README

ocaml-libvirt
----------------------------------------------------------------------

Copyright (C) 2007-2022 Red Hat Inc. and various authors
https://ocaml.libvirt.org/
https://libvirt.org/

This is a complete set of OCaml bindings around libvirt, exposing all
known functionality to OCaml programs.

Building
----------------------------------------------------------------------

  autoreconf -i         # If you are building from git.
  ./configure           # Checks that you have all the required bits.
  make                  # Build bytecode and/or native code library.
  make install          # Install in OCaml directory.
  make doc              # Build HTML documentation in html/ subdirectory.


Programming
----------------------------------------------------------------------

For documentation on these bindings, read libvirt.mli and/or 'make
doc' and browse the HTML documentation in the html/ subdirectory.

For documentation on libvirt itself, see https://libvirt.org/html/


License
----------------------------------------------------------------------

The library is distributed under the GNU LGPL, version 2 or above,
with the OCaml linking exception.  Please see COPYING.LIB for details.

Examples are public domain.


Subdirectories
----------------------------------------------------------------------

libvirt/		The OCaml bindings.
examples/		Some example programs using the bindings.