X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=README;h=35c9c6913b5eda0422f0407f94f83b26ba3ecbaf;hb=9cf8d98711dff888f5bfa8efd52ca7b8cf8bfa07;hp=19ddae26a27fa62ea642c0e445192c5385126e26;hpb=dfa6a6e1d15314e9f259f1df9368659a998dfbe2;p=ext%2Fsubsurface.git

diff --git a/README b/README
index 19ddae2..35c9c69 100644
--- a/README
+++ b/README
@@ -4,20 +4,38 @@ 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.
 
 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
@@ -49,3 +67,24 @@ the right to pass it on as an open source patch.
 
 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
+
+	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
+	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.
+
+	Reported-by: whoever-reported-it
+	Signed-off-by: Your Name <youremail@yourhost.com>
+
+where that header line really should be meaningful, and really should be
+just one line.  That header line is what is shown by tools like gitk and
+shortlog, and should summarize the change in one readable line of text,
+independently of the longer explanation.