Tracking changes to tanks is trivial

[ext/subsurface.git] / README

diff --git a/README b/README
index 5947febb702cd072553b6a686121a2ff3cfb3b14..204b9a3bf8290a8e454f65a464e4e5df1d02fa60 100644 (file)
--- a/README
+++ b/README
@@ -18,7 +18,7 @@ You also need to have libdivecomputer installed, which goes something like this:
 Usage:
 
        make
 Usage:
 
        make

-       ./divelog dives/*.xml
+       ./subsurface dives/*.xml

 
 to see my dives (with no notes or commentary).
 
 
 to see my dives (with no notes or commentary).
 


@@ -26,17 +26,36 @@ Or, if you have a dive computer supported by libdivecomputer (and
 connected to /dev/ttyUSB0), you can just do
 
        make
 connected to /dev/ttyUSB0), you can just do
 
        make

-       ./divelog
+       ./subsurface

 
 and select "Import" from the File menu, tell it what dive computer you
 have, and hit "OK".
 
 There's a lot of duplicates in the XML files that come as an example,
 
 and select "Import" from the File menu, tell it what dive computer you
 have, and hit "OK".
 
 There's a lot of duplicates in the XML files that come as an example,

-and divelog will de-duplicate the ones that are exactly the same (just
-because they were imported multiple times).  But at least two of the
-dives have duplicates that were edited by Dirk in the Suunto Dive
+and subsurface will de-duplicate the ones that are exactly the same
+(just because they were imported multiple times).  But at least two of
+the dives have duplicates that were edited by Dirk in the Suunto Dive

 Manager, so they don't trigger the "exact duplicates" match.
 
 Manager, so they don't trigger the "exact duplicates" match.
 

+Implementation details:
+
+main.c - program frame
+dive.c - creates and maintaines the internal dive list structure
+libdivecomputer.c 
+uemis.c 
+parse-xml.c 
+save-xml.c - interface with dive computers and the XML files 
+profile.c - creates the data for the profile and draws it using cairo
+
+A first UI has been implemented in gtk and an attempt has been made to
+separate program logic from UI implementation. 
+
+gtk-gui.c - overall layout, main window of the UI
+divelist.c  - list of dives subsurface maintains
+equipment.c - equipment / tank information for each dive
+info.c      - detailed dive info 
+print.c     - printing 
+

 WARNING! I wasn't kidding when I said that I've done this by reading
 gtk2 tutorials as I've gone along.  If somebody is more comfortable with
 gtk, feel free to send me (signed-off) patches.
 WARNING! I wasn't kidding when I said that I've done this by reading
 gtk2 tutorials as I've gone along.  If somebody is more comfortable with
 gtk, feel free to send me (signed-off) patches.