README

   1 Ametros Dive Computer
   2 =====================
   3
   4 Copyright (C) 2010 Geoff Johnstone. All rights reserved.
   5
   6 Do not use this for diving. If you use this for diving and you kill yourself
   7 or get decompression sickness then it's your own fault. If you choose to
   8 ignore this advice then please don't rely on the numbers that this program
   9 generates. Use other tools. Check its output. Get someone else to do the dive
  10 first, and only dive yourself if they survive, etc.
  11
  12 This program is provided as is, WITHOUT WARRANTIES OF ANY KIND, including
  13 fitness for any purpose whatsoever.
  14
  15 YOU USE THIS AT YOUR OWN RISK. If you kill yourself, don't come round to my
  16 place expecting any sympathy / apology / compensation.
  17
  18 If you don't know me and trust me with your life then you're stupid.
  19 If you do know me then you'll know not to trust me with your life.
  20
  21 If you're still interested and prepared to take responsibility for your own
  22 actions, rather than expecting someone else to, then please read on.
  23
  24
  25 Introduction
  26 ------------
  27 The Ametros Dive Computer reads dive plans in a variety of formats (including
  28 DDPlan and APD Projection HTML output), computes *ascent* gas volumes and
  29 outputs the result in a variety of formats. Surviving your descent to the
  30 bottom and whatever you get up to down there is your own problem.
  31
  32
  33 Usage
  34 -----
  35 $ java -jar [options] plan...
  36
  37 Options:
  38
  39  -f, --format : output format: html, xhtml, xml or xls.
  40  -o, --output : output filename.
  41
  42 If you omit -o / --output then it outputs to standard output.
  43 If you omit -f / --format but include -o / --output then it guesses the format.
  44
  45
  46 Licence
  47 -------
  48 GNU General Public Licence v3, assuming that that's compatible with the
  49 various third-party libraries that I've used. If not, speak to a lawyer
  50 and suggest something else to me.
  51
  52
  53 Third-Party Libraries
  54 ---------------------
  55 The Ametros Dive Computer uses the following third-party libraries:
  56
  57 Apache Velocity for [X]HTML output:
  58
  59   Apache Velocity
  60
  61   Copyright (C) 2000-2007 The Apache Software Foundation
  62
  63   This product includes software developed at
  64   The Apache Software Foundation (http://www.apache.org/).
  65
  66 Apache POI for XLS handling:
  67
  68   Apache POI
  69   Copyright 2009 The Apache Software Foundation
  70
  71   This product includes software developed by
  72   The Apache Software Foundation (http://www.apache.org/).
  73
  74   This product contains the DOM4J library (http://www.dom4j.org).
  75   Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
  76
  77   This product contains parts that were originally based on software from BEA.
  78   Copyright (c) 2000-2003, BEA Systems, <http://www.bea.com/>.
  79
  80   This product contains W3C XML Schema documents. Copyright 2001-2003 (c)
  81   World Wide Web Consortium (Massachusetts Institute of Technology, European
  82   Research Consortium for Informatics and Mathematics, Keio University)
  83
  84   This product contains the Piccolo XML Parser for Java
  85   (http://piccolo.sourceforge.net/). Copyright 2002 Yuval Oren.
  86
  87   This product contains the chunks_parse_cmds.tbl file from the vsdump program.
  88   Copyright (C) 2006-2007 Valek Filippov (frob@df.ru)
  89
  90 JOptSimple for command line parsing:
  91
  92   Copyright (c) 2009 Paul R. Holser, Jr.
  93
  94   Permission is hereby granted, free of charge, to any person obtaining
  95   a copy of this software and associated documentation files (the
  96   "Software"), to deal in the Software without restriction, including
  97   without limitation the rights to use, copy, modify, merge, publish,
  98   distribute, sublicense, and/or sell copies of the Software, and to
  99   permit persons to whom the Software is furnished to do so, subject to
 100   the following conditions:
 101
 102   The above copyright notice and this permission notice shall be
 103   included in all copies or substantial portions of the Software.
 104
 105   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 106   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 107   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 108   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 109   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 110   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 111   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 112