Removed $Id$ everywhere.
[virt-top.git] / virt-top / README
index 8618fad..86dfd02 100644 (file)
@@ -1,5 +1,3 @@
-$Id: README,v 1.1 2007/08/30 13:52:40 rjones Exp $
-
 The code is structured into these files:
 
   virt_top_utils.ml
@@ -11,12 +9,18 @@ The code is structured into these files:
 
     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