X-Git-Url: http://git.annexia.org/?p=virt-top.git;a=blobdiff_plain;f=virt-top%2FREADME;h=86dfd0218db5086528114ca1ed0a458d9b0d5bad;hp=c3752c68173691f7a999c03d380ccb18b56ac813;hb=0e09861c06a0c274bcfdacceaee347f8aaa969cb;hpb=a8b837d5018c488a130fcbea425904817a862210

diff --git a/virt-top/README b/virt-top/README
index c3752c6..86dfd02 100644
--- a/virt-top/README
+++ b/virt-top/README
@@ -1,17 +1,26 @@
-$Id: README,v 1.1 2007/08/30 13:52:40 rjones Exp $
-
 The code is structured into these files:
 
+  virt_top_utils.ml
+
+    String functions and other small utility functions.  This is
+    included directly into virt_top.ml.
+
   virt_top.ml
 
     This is the virt-top program.
 
-    The interesting function is called 'redraw', which is responsible
-    for redrawing the display on each frame.  Another interesting
-    function is 'start_up' which handles all start-up stuff, eg.
-    command line arguments, connecting to the hypervisor, enabling
-    curses.  The function 'main_loop' runs the main loop and has
-    sub-functions to deal with keypresses, help screens and so on.
+    The two interesting functions are called 'collect' and 'redraw'.
+
+    'collect' collects all the information about domains, etc.
+
+    'redraw' updates the display on each frame.
+
+    Another interesting function is 'start_up' which handles all
+    start-up stuff, eg. command line arguments, connecting to the
+    hypervisor, enabling curses.
+
+    The function 'main_loop' runs the main loop and has sub-functions
+    to deal with keypresses, help screens and so on.
 
   virt_top_xml.ml
 
@@ -24,7 +33,7 @@ The code is structured into these files:
 
   virt_top_csv.ml
 
-    Any code which need the optional ocaml-csv library goes
+    Any code which needs the optional ocaml-csv library goes
     in here.  This implements the --csv command line option.
 
   virt_top_main.ml