Skip to content
Advanced multi-platform divelog based on Qt
C++ C XSLT Shell QML CMake Other
Latest commit 1cf71a4 Apr 26, 2016 @dirkhh dirkhh QML UI: start out with save button visible
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Failed to load latest commit information.
.tx Add simple glossary Dec 29, 2013
Documentation Don't use CRLF in documentation files Mar 16, 2016
ReleaseNotes Update various files to reflect the development towards 4.6 Nov 9, 2015
android-mobile Android build: pass in build nr Mar 5, 2016
android Open subsurface on attaching divecomputer Aug 20, 2015
appdata Replace other references to hohndel.org Nov 18, 2014
cmake/Modules QML UI: all these changes certainly deserve a new version Apr 1, 2016
core Fix time parsing for Divesoft Freedom Apr 25, 2016
desktop-widgets DL7: parse temperature and cylinder pressure Apr 25, 2016
dives SmartTrak import - Add example divelog file Nov 12, 2015
icons iOS build: add missing icon Mar 23, 2016
marbledata Add 1x1 transparent png to replace missing marble data Jul 9, 2015
mobile-widgets QML UI: start out with save button visible Apr 26, 2016
packaging Add Ubuntu Xenial to be built (16.04) Apr 26, 2016
printing_templates printing_templates: mark 'dive.notes' as 'safe' Nov 15, 2015
profile-widget Only do 9 minute interval for min/max/avg Apr 20, 2016
qt-models DiveListModel: don't add the dives one at a time Apr 5, 2016
scripts Move subsurface-core to core and qt-mobile to mobile-widgets Apr 4, 2016
smtk-import SmartTrak import - Add build capability to cmake Nov 12, 2015
tests Fix compilation with the new folder architecture Apr 5, 2016
theme HTML Export: Ignore case when searching for tags Oct 4, 2015
translations Update strings Oct 29, 2015
xslt CSV import: support min.sec format Apr 25, 2016
.clang-format Reenable ForEachMacros in .clang-format Oct 19, 2015
.gitattributes Don't use CRLF in documentation files Mar 16, 2016
.gitignore Move subsurface-core to core and qt-mobile to mobile-widgets Apr 5, 2016
CMakeLists.txt Move subsurface-core to core and qt-mobile to mobile-widgets Apr 5, 2016
CodingStyle CodingStype: add explanation how to install the QtCreator settings Sep 7, 2015
INSTALL Add automake to the list of Debian dependencies Jan 7, 2016
README Update various files to reflect the development towards 4.6 Nov 10, 2015
Readme.testing Information on writing test cases Apr 15, 2014
Readme.ubuntu Update Readme.ubuntu Jan 15, 2015
SupportedDivecomputers.html Mention Shearwater Nerd Oct 18, 2015
SupportedDivecomputers.txt Mention Shearwater Nerd Oct 19, 2015
TODO.CCR Update todo list for CCR Nov 18, 2014
descriptor3.tsv Add structured file with list of supported dive computers Dec 13, 2013
export-html.cpp export-html needs to actually calculate the statistics Oct 7, 2015
gpl-2.0.txt Add a copy of the GPL v2 to the project Sep 26, 2011
subsurface-desktop-helper.cpp Move subsurface-core to core and qt-mobile to mobile-widgets Apr 5, 2016
subsurface-desktop-main.cpp Move subsurface-core to core and qt-mobile to mobile-widgets Apr 5, 2016
subsurface-mobile-helper.cpp Make it easy to access the sort model from the QML manager Apr 14, 2016
subsurface-mobile-main.cpp Move subsurface-core to core and qt-mobile to mobile-widgets Apr 5, 2016
subsurface.debug Add subsurface.debug script to help debugging and install it (for Lin… Oct 29, 2015
subsurface.desktop Add a trailing ';' to the Keywords in the subsurface.desktop file Dec 22, 2014
subsurface.qrc Add icon for georeference in preferences Sep 23, 2015
subsurface_enabled_translations Read the translations from the translations file Dec 16, 2015
terms Be more consistent in partial pressure naming Jun 23, 2014
wreck.jpg Include images in profile Feb 6, 2014

README

This is the README file for the development version of Subsurface towards
version 4.6

Please check the ReleaseNotes.txt for details about new features and
changes since Subsurface 4.5 (and earlier versions).

Subsurface can be found at http://subsurface-divelog.org

Our user forum is at http://subsurface-divelog.org/user-forum/
We also try to respond to questions in the ScubaBoard.com dive software
forum at http://www.scubaboard.com/forums/dive-software/

Report bugs and issues at http://trac.subsurface-divelog.org

License: GPLv2

You can get the sources to the latest development version from the git
repository:

git clone git://git.subsurface-divelog.org/subsurface.git .

You can also browse the sources via gitweb at the same site.

If you want the latest release (instead of the bleeding edge
development version) you can either get this via git or the release tar
ball. After cloning run the following command:

git checkout v4.5.1  (or whatever the last release is)

or download a tar ball from:

http://subsurface-divelog.org/downloads/Subsurface-4.5.1.tgz

Detailed build instructions can be found in the INSTALL file.

Basic Usage:
============

Install and start from the desktop, or you can run it locally from the
build directory:

On Linux:

$ ./subsurface

On Mac:

$ open Subsurface.app

Native builds on Windows are not really supported (the official Windows
installers are both cross-built on Linux).

You can give a data file as command line argument, or (once you have
set this up in the Preferences) Subsurface picks a default file for
you when started from the desktop or without an argument.

If you have a dive computer supported by libdivecomputer, you can just
select "Import from Divecomputer" from the "Import" menu, select which
dive computer you have (and where it is connected if you need to), and
hit "OK".

The latest list of supported dive computers can be found in the file
SupportedDivecomputers.txt.

Much more detailed end user instructions can be found from inside
Subsurface by selecting Help (typically F1). When building from source
this is also available as Documentation/user-manual.html. The
documentation for the latest release is also available on-line
http://subsurface-divelog.org/documentation/


Contributing:
=============

There is a mailing list for developers: subsurface@subsurface-divelog.org
Go to http://lists.subsurface-divelog.org/cgi-bin/mailman/listinfo/subsurface
to subscribe.

If you want to contribute code, please either send signed-off patches or
a pull request with signed-off commits.  If you don't sign off on them,
we will not accept them. This means adding a line that says
"Signed-off-by: Name <email>" at the end of each commit, indicating that
you wrote the code and have the right to pass it on as an open source
patch.

See: http://developercertificate.org/

Also, please write good git commit messages.  A good commit message
looks like this:

	Header line: explain the commit in one line (use the imperative)

	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 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.

	Make sure you explain your solution and why you're doing what you're
	doing, as opposed to describing what you're doing. Reviewers and your
	future self can read the patch, but might not understand why a
	particular solution was implemented.

	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. Please use verbs in the
imperative in the commit message, as in "Fix bug that...", "Add
file/feature ...", or "Make Subsurface..."


A bit of Subsurface history:
============================

In fall of 2011, when a forced lull in kernel development gave him an
opportunity to start on a new endeavor, Linus Torvalds decided to tackle
his frustration with the lack of decent divelog software on Linux.

Subsurface is the result of the work of him and a team of developers since
then. It now supports Linux, Windows and MacOS and allows data import from
a large number of dive computers and several existing divelog programs. It
provides advanced visualization of the key information provided by a
modern dive computer and allows the user to track a wide variety of data
about their diving.

In fall of 2012 Dirk Hohndel took over as maintainer of Subsurface.
Something went wrong with that request. Please try again.