Fix profile and average depth for freedives

[ext/subsurface.git] / README

diff --git a/README b/README
index 1660f66eb9afa1a1e9e3f80c0bf11a02478dc07c..66d953075e013b4de5df063b75bfac97b711d9b3 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 Half-arsed divelog software in C.
 
-I'm tired of java programs that don't work etc.
+I'm tired of Java programs that don't work etc.
 
 License: GPLv2
 
@@ -32,20 +32,87 @@ Usage:
 
 to see my dives (with no notes or commentary).
 
-Or, if you have a dive computer supported by libdivecomputer (and
-connected to /dev/ttyUSB0), you can just do
+Or, if you have a dive computer supported by libdivecomputer, you can
+just do
 
        make
        ./subsurface
 
-and select "Import" from the File menu, tell it what dive computer you
-have, and hit "OK".
+and select "Import" from the Log menu, tell it what dive computer you
+have (and where it is connected if you need to), and hit "OK".
+
+NOTE! There are often multiple models of dive computers that import
+exactly the same way.  If you have a Suunto Gekko, for example, the
+import function works fine - even if you don't find the Gekko listed
+explicitly.  It has the same import engine as the older Suunto Vyper
+(not "Vyper Air").
+
+So check the (incomplete?) list of supported dive computers below, and
+see which ones show up together.  If you have the "Aeris Elite T3", for
+example, you'd notice that it's in the same group with the "Oceanic Atom
+2", and use that choice to import.
+
+Suunto:
+
+ * Solution
+
+ * Eon, Solution Alpha and Solution Nitrox/Vario
+
+ * Vyper, Cobra, Vytec, Vytec DS, D3, Spyder, Gekko, Mosquito, Stinger and Zoop
+
+ * Vyper2, Cobra2, Cobra3, Vyper Air and HelO2
+
+ * D9, D6 and D4
+
+Uwatec:
+
+ * Aladin
+
+ * Memomouse
+
+ * Smart and Galileo (infrared)
+
+Reefnet:
+
+ * Sensus
+
+ * Sensus Pro
+
+ * Sensus Ultra
+
+Oceanic, Aeris, Sherwood, Hollis, Genesis and Tusa (Pelagic):
+
+ * VT Pro, Versa Pro, Pro Plus 2, Wisdom, Atmos 2, Atmos AI, Atmos
+Elite, ...
+
+ * Veo 250, Veo 180Nx, XR2, React Pro, DG02, Insight, ...
+
+ * Atom 2.0, VT3, Datamask, Geo, Geo 2.0, Veo 2.0, Veo 3.0, Pro Plus 2.1,
+Compumask, Elite T3, Epic, Manta, IQ-900 (Zen), IQ-950 (Zen Air),
+IQ-750 (Element II), ...
+
+Mares:
+
+ * Nemo, Nemo Excel, Nemo Apneist, ...
+
+ * Puck, Puck Air, Nemo Air, Nemo Wide, ...
+
+ * Icon HD
+
+Heinrichs Weikamp:
+
+ * OSTC, OSTC Mk.2 and OSTC 2N
+
+Cressi, Zeagle and Mares (Seiko):
+
+ * Edy, Nemo Sport
+
+ * N2iTiON3
+
+Atomic Aquatics:
+
+ * Cobalt
 
-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:
 
@@ -94,13 +161,13 @@ See: http://gerrit.googlecode.com/svn/documentation/2.0/user-signedoffby.html
 Also, please write good git commit messages.  A good commit message
 looks like this:
 
-       header line: explaining the commit in one line
+       Header line: explaining the commit in one line
 
        Body of commit message is a few lines of text, explaining things
        in more detail, possibly giving some background about the issue
        being fixed, etc etc.
 
-       The body of the commit message can be several paragrahps, and
+       The body of the commit message can be several paragraphs, and
        please do proper word-wrap and keep columns shorter than about
        74 characters or so. That way "git log" will show things
        nicely even when it's indented.