Separate out the UI from the program logic

[ext/subsurface.git] / README

diff --git a/README b/README
index a9eb649ee052697bc0c554b66df1e18a873450d9..204b9a3bf8290a8e454f65a464e4e5df1d02fa60 100644 (file)
--- a/README
+++ b/README
@@ -4,20 +4,57 @@ I'm tired of java programs that don't work etc.
 
 License: GPLv2
 
-You need libxml2-devel and gtk2-devel to build this.
+You need libxml2-devel, gtk2-devel and GConf2-devel to build this.
+
+You also need to have libdivecomputer installed, which goes something like this:
+
+       git clone git://libdivecomputer.git.sourceforge.net/gitroot/libdivecomputer/libdivecomputer
+       cd libdivecomputer
+       autoreconf --install
+       ./configure
+       make
+       sudo make install
 
 Usage:
 
        make
-       ./divelog dives/*.xml
+       ./subsurface dives/*.xml
 
 to see my dives (with no notes or commentary).
 
-There's a lot of duplicates in there, 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 Manager, so they don't trigger the "exact
-duplicates" match.
+Or, if you have a dive computer supported by libdivecomputer (and
+connected to /dev/ttyUSB0), you can just do
+
+       make
+       ./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 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.
+
+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