Move main code to virt_df_main.ml and provide explicit interface virt_df.mli

[virt-top.git] / README

diff --git a/README b/README
index 57063ba..7fb9726 100644 (file)
--- a/README
+++ b/README
@@ -21,52 +21,64 @@ the packages below if you want to build from source.
 
                     W h a t   y o u   w a n t   t o   b u i l d
 
-                |Bindings, |Docs,    |virt-top |virt-ctrl |Windows
-                |examples, |manpages |         |          |version
-                |mlvirsh   |         |         |          |
-  --------------+----------+---------+---------+----------+---------
-  GNU make      | R        | R       | R       | R        | R
-                |          |         |         |          |
-  gcc           | R        |         | R       | R        | R
-                |          |         |         |          |
-  libvirt       | R        |         | R       | R        | R
-                | >= 0.2.1 |         |         |          |
-                |          |         |         |          |
-  ocaml         | R        |         | R       | R        | R
-                | >= 3.08  |         |         |          |
-                |          |         |         |          |
-  findlib       | HR       | R       | HR      | HR       | n/a
-                |          |         |         |          |
-  MinGW + MSYS  |          |         |         |          | R
-  --------------+----------+---------+---------+----------+---------
-  ocamldoc      |          | R       |         |          | O
-                |          |         |         |          |
-  perldoc       |          | O       |         |          |
-  --------------+----------+---------+---------+----------+---------
-  ocaml-curses  |          |         | R       |          |
-                |          |         |         |          |
-  Extlib        |          |         | R       |          |
-                |          |         |         |          |
-  xml-light     |          |         | O       |          |
-                |          |         |         |          |
-  ocaml-calendar|          |         | O       |          |
-                |          |         |         |          |
-  ocaml CSV     |          |         | O       |          |
-  --------------+----------+---------+---------+----------+---------
-  GTK2          |          |         |         | R        | O
-                |          |         |         |          |
-  lablgtk2      |          |         |         | R        | O
-                |          |         |         |          |
-  ocaml-dbus    |          |         |         | O        |
-  --------------+----------+---------+---------+----------+---------
-  NSIS          |          |         |         |          | O
-  --------------+----------+---------+---------+----------+---------
+                |Bindings, |Docs,    |virt-top |virt-ctrl |virt-df   |Windows
+                |examples, |manpages |         |          |          |version
+                |mlvirsh   |         |         |          |          |
+  --------------+----------+---------+---------+----------+----------+------
+  GNU make      | R        | R       | R       | R        | R        | R
+                |          |         |         |          |          |
+  gcc           | R        |         | R       | R        | R        | R
+                |          |         |         |          |          |
+  libvirt       | R        |         | R       | R        | R        | R
+                | >= 0.2.1 |         |         |          |          |
+                |          |         |         |          |          |
+  ocaml         | R        |         | R       | R        | R        | R
+                | >= 3.08  |         |         |          | >= 3.10  |
+                |          |         |         |          |          |
+  findlib       | HR       | R       | HR      | HR       | HR       | Note [1]
+                |          |         |         |          |          |
+  ocaml-gettext | O        | O       | O       | O        | O        | Note [2]
+                |          |         |         |          |          |
+  MinGW + MSYS  |          |         |         |          |          | R
+  --------------+----------+---------+---------+----------+----------+------
+  ocamldoc      |          | R       |         |          |          | O
+                |          |         |         |          |          |
+  perldoc       |          | O       |         |          |          |
+  --------------+----------+---------+---------+----------+----------+------
+  ocaml-curses  |          |         | R       |          |          |
+                |          |         |         |          |          |
+  Extlib        |          |         | R       |          | R        |
+                |          |         |         |          |          |
+  xml-light     |          |         | O       |          | R        |
+                |          |         |         |          |          |
+  ocaml-calendar|          |         | O       |          |          |
+                |          |         |         |          |          |
+  ocaml CSV     |          |         | O       |          |          |
+                |          |         |         |          |          |
+  bitmatch      |          |         |         |          | R        |
+  --------------+----------+---------+---------+----------+----------+------
+  GTK2          |          |         |         | R        |          | O
+                |          |         |         |          |          |
+  lablgtk2      |          |         |         | R        |          | O
+                |          |         |         | >= 2.10.0|          |
+  ocaml-dbus    |          |         |         | O        |          |
+                |          |         |         | >= 0.06  |          |
+  gnome-icon-theme         |         |         | O        |          |
+  --------------+----------+---------+---------+----------+----------+------
+  NSIS          |          |         |         |          |          | O
+  --------------+----------+---------+---------+----------+----------+------
 
    R = required
    HR = highly recommended (use if possible)
    O = optional (just improves functionality, but not required)
    n/a = not available
 
+Note [1]: Findlib was recently ported to Windows and in future we may
+require it because it will let us remove a lot of hacks from the
+Makefiles.
+
+Note [2]: It's not clear if ocaml-gettext works on Windows.
+
 Where to get the packages:
 
   libvirt >= 0.2.1 from http://libvirt.org/ (get the latest version available)
@@ -78,13 +90,18 @@ Where to get the packages:
   findlib          from http://www.ocaml-programming.de/packages/
                      or packaged in Debian, Ubuntu and Fedora as 'ocaml-findlib'
 
+  ocaml-gettext    from http://www.le-gall.net/sylvain+violaine/ocaml-gettext.html
+                + patch for OCaml 3.10:
+                http://www.annexia.org/tmp/ocaml-gettext-0.2.0-20080321.patch
+               (This should appear in ocaml-gettext 0.3.0 shortly).
+
   MinGW + MSYS     from http://www.mingw.org/ (only needed for Windows)
 
-  ocamldoc           part of OCaml itself
+  ocamldoc         part of OCaml itself
                      or part of the ocaml package in Debian, Ubuntu
                      or packaged in Fedora as 'ocaml-ocamldoc'
 
-  perldoc            part of Perl
+  perldoc          part of Perl
                      or packaged in Debian, Ubuntu and Fedora
 
   ocaml-curses     from http://www.nongnu.org/ocaml-tmk/
@@ -107,14 +124,20 @@ Where to get the packages:
                      or packaged in Debian, Ubuntu as 'libcalendar-ocaml-dev'
                      or packaged in Fedora as 'ocaml-calendar-devel'
 
+  bitmatch         from http://et.redhat.com/~rjones/bitmatch/
+
   GTK2             from http://gtk.org/
                      or packaged in Debian, Ubuntu and Fedora
 
-  lablgtk2         from http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgtk.html
+  lablgtk2 >= 2.10.0
+                   from http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgtk.html
                      or packaged in Debian, Ubuntu as 'liblablgtk2-ocaml-dev'
-                     or packaged in Fedora as 'ocaml-lablgtk-devel'
+                     or packaged in Fedora 9 as 'ocaml-lablgtk-devel'
+
+  gnome-icon-theme part of GNOME
 
-  ocaml-dbus       from http://tab.snarc.org/projects/ocaml_dbus/
+  ocaml-dbus >= 0.06
+                   from http://tab.snarc.org/projects/ocaml_dbus/
                      or packaged in Fedora 9 as 'ocaml-dbus-devel'
                      (not yet available for Debian or Ubuntu AFAIK)