Skip to content
Advanced multi-platform divelog based on Qt
C++ C XSLT Shell QML CMake Other
Latest commit 55eb416 @dirkhh dirkhh Fix incorrect reference to endEditMode()
Not sure how that slipped through the cracks.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Failed to load latest commit information.
.tx Add simple glossary
Documentation Mobile user-manual: Add text that explains action button
ReleaseNotes Update various files to reflect the development towards 4.6
android-mobile Subsurface-mobile on Android: change the splash screen methodology
android Open subsurface on attaching divecomputer
appdata Replace other references to hohndel.org
cmake/Modules Force the creation of some soft-links
desktop-widgets Update copyright for 2016
dives SmartTrak import - Add example divelog file
icons Add splash screen for android-mobile
marbledata Add 1x1 transparent png to replace missing marble data
packaging Build Android mobile app against latest OpenSSL
printing_templates printing_templates: mark 'dive.notes' as 'safe'
profile-widget Profile: don't compile code that isn't needed on mobile
qt-mobile Fix incorrect reference to endEditMode()
qt-models Do not run the deco calculations in the mobile app
scripts Simplify building of Android build from one source tree
smtk-import SmartTrak import - Add build capability to cmake
subsurface-core Add helper function to parse gasmix strings
tests Silence compiler warnings
theme HTML Export: Ignore case when searching for tags
translations Update strings
xslt Support PSI on CSV import
.clang-format Reenable ForEachMacros in .clang-format
.gitattributes Ignore some files when archiving.
.gitignore Remove plasma mobile components, pull from upstream at build time
CMakeLists.txt Correctly handle SubsurfaceMobile
CodingStyle CodingStype: add explanation how to install the QtCreator settings
INSTALL Add automake to the list of Debian dependencies
README Update various files to reflect the development towards 4.6
Readme.testing Information on writing test cases
Readme.ubuntu Update Readme.ubuntu
SupportedDivecomputers.html Mention Shearwater Nerd
SupportedDivecomputers.txt Mention Shearwater Nerd
TODO.CCR Update todo list for CCR
descriptor3.tsv Add structured file with list of supported dive computers
export-html.cpp export-html needs to actually calculate the statistics
gpl-2.0.txt Add a copy of the GPL v2 to the project
subsurface-desktop-helper.cpp Start the Plugin Manager
subsurface-desktop-main.cpp Start to use the QSettings ObjectWrapper
subsurface-mobile-helper.cpp Use our own sort proxy model class
subsurface-mobile-main.cpp Mobile: always show divecomputer reported ceiling in red
subsurface.debug Add subsurface.debug script to help debugging and install it (for Lin…
subsurface.desktop Add a trailing ';' to the Keywords in the subsurface.desktop file
subsurface.qrc Add icon for georeference in preferences
subsurface_enabled_translations Read the translations from the translations file
terms Be more consistent in partial pressure naming
wreck.jpg Include images in profile

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.