README

   1 Half-arsed divelog software in C.
   2
   3 I'm tired of java programs that don't work etc.
   4
   5 License: GPLv2
   6
   7 You need libxml2-devel and gtk2-devel to build this.
   8
   9 Usage:
  10
  11         make
  12         ./divelog dives/*.xml
  13
  14 to see my dives (with no notes or commentary).
  15
  16 There's a lot of duplicates in there, and divelog will de-duplicate the
  17 ones that are exactly the same (just because they were imported multiple
  18 times).  But at least two of the dives have duplicates that were edited
  19 by Dirk in the Suunto Dive Manager, so they don't trigger the "exact
  20 duplicates" match.
  21
  22 WARNING! I wasn't kidding when I said that I've done this by reading
  23 gtk2 tutorials as I've gone along.  If somebody is more comfortable with
  24 gtk, feel free to send me (signed-off) patches.
  25
  26 Just as an example of the extreme hackiness of the code, I don't even
  27 bother connecting a signal for the "somebody edited the dive info"
  28 cases.  I just save/restore the dive info every single time you switch
  29 dives.  Christ! That's truly lame.
  30
  31 Also, I don't actually integrate directly with libdivecomputer, I just
  32 read the XML files it can spit out.  But I included my own raw dive
  33 profile xml files for anybody who isn't a diver, but decides that they
  34 want to educate me in gtk.
  35
  36 NOTE! Some of the dives are pretty pitiful.  All the last dives are from
  37 my divemaster course, so they are from following open water students
  38 along (many of them the confined*water dives).  There a lot of the
  39 action is at the surface, so some of the "dives" are 4ft deep and 2min
  40 long.
  41
  42 Contributing:
  43
  44 Please either send me signed-off patches or a pull request with
  45 signed-off commits.  If you don't sign off on them, I will not accept
  46 them. This means adding a line that says "Signed-off-by: Name <email>"
  47 at the end of each commit, indicating that you wrote the code and have
  48 the right to pass it on as an open source patch.
  49
  50 See: http://gerrit.googlecode.com/svn/documentation/2.0/user-signedoffby.html
  51
  52 Also, please write good git commit messages.  A good commit message
  53 looks like this:
  54
  55         header line: explaining the commit in one line
  56
  57         Body of commit message is a few lines of text, explaining things
  58         in more detail, possibly giving some background about the issue
  59         being fixed, etc etc.
  60
  61         The body of the commit message can be several paragrahps, and
  62         please do proper word-wrap and keep columns shorter than about
  63         74 characters or so. That way "git log" will show things
  64         nicely even when it's indented.
  65
  66         Reported-by: whoever-reported-it
  67         Signed-off-by: Your Name <youremail@yourhost.com>
  68
  69 where that header line really should be meaningful, and really should be
  70 just one line.  That header line is what is shown by tools like gitk and
  71 shortlog, and should summarize the change in one readable line of text,
  72 independently of the longer explanation.