2021-03-31 16:06:35 +00:00
# Subsurface
2020-09-11 07:31:14 +00:00
2024-04-24 00:53:17 +00:00
[](https://github.com/subsurface/subsurface/actions/workflows/windows.yml)
[](https://github.com/subsurface/subsurface/actions/workflows/mac.yml)
[](https://github.com/subsurface/subsurface/actions/workflows/ios.yml)
[](https://github.com/subsurface/subsurface/actions/workflows/android.yml)
2020-09-11 07:31:14 +00:00
2024-04-24 00:53:17 +00:00
[](https://github.com/subsurface/subsurface/actions/workflows/linux-snap.yml)
2024-05-08 10:39:06 +00:00
[](https://github.com/subsurface/subsurface/actions/workflows/linux-ubuntu-16.04-5.12-appimage.yml)
2024-05-07 07:27:42 +00:00
[](https://github.com/subsurface/subsurface/actions/workflows/linux-ubuntu-24.04-5.15.yml)
[](https://github.com/subsurface/subsurface/actions/workflows/linux-fedora-35-qt6.yml)
[](https://github.com/subsurface/subsurface/actions/workflows/linux-debian-trixie-5.15.yml)
2017-11-04 00:02:18 +00:00
2024-04-24 00:53:17 +00:00
[](https://scan.coverity.com/projects/subsurface-divelog-subsurface)
2014-07-13 04:09:32 +00:00
2014-12-17 04:33:28 +00:00
Subsurface can be found at http://subsurface-divelog.org
Our user forum is at http://subsurface-divelog.org/user-forum/
2020-09-12 17:48:48 +00:00
Report bugs and issues at https://github.com/Subsurface/subsurface/issues
2014-07-13 04:09:32 +00:00
2011-09-01 17:09:53 +00:00
License: GPLv2
2011-09-03 15:53:05 +00:00
2024-05-31 21:42:51 +00:00
We are releasing 'nightly' builds of Subsurface that are built from the latest version of the code. Versions of this build for Windows, macOS, Android (requiring sideloading), and a Linux AppImage can be downloaded from the [Latest Dev Release ](https://www.subsurface-divelog.org/latest-release/ ) page on [our website ](https://www.subsurface-divelog.org/ ). Alternatively, they can be downloaded [directly from GitHub ](https://github.com/subsurface/nightly-builds/releases ). Additionally, those same versions are
2023-12-04 12:01:29 +00:00
posted to the Subsurface-daily repos on Ubuntu Launchpad, Fedora COPR, and
2024-05-31 21:42:51 +00:00
OpenSUSE OBS, and released to [Snapcraft ](https://snapcraft.io/subsurface ) into the 'edge' channel of subsurface.
2017-10-21 01:23:43 +00:00
2013-02-27 23:25:17 +00:00
You can get the sources to the latest development version from the git
repository:
2012-10-20 04:22:59 +00:00
2017-11-04 00:02:18 +00:00
```
2020-04-26 23:36:27 +00:00
git clone https://github.com/Subsurface/subsurface.git
2017-11-04 00:02:18 +00:00
```
2012-10-20 04:22:59 +00:00
2017-01-02 23:55:00 +00:00
You can also fork the repository and browse the sources at the same site,
2020-04-26 23:36:27 +00:00
simply using https://github.com/Subsurface/subsurface
2012-10-20 04:22:59 +00:00
2024-05-31 21:42:51 +00:00
Additionally, artifacts for Windows, macOS, Android, Linux AppImage, and iOS (simulator build) are generated for all open pull requests and linked in pull request comments. Use these if you want to test the changes in a specific pull request and provide feedback before it has been merged.
2013-02-27 23:25:17 +00:00
2024-05-31 21:42:51 +00:00
If you want a more stable version that is a little bit more tested you can get this from the [Curent Release ](https://www.subsurface-divelog.org/current-release/ ) page on [our website ](https://www.subsurface-divelog.org/ ).
2013-12-12 03:16:42 +00:00
2024-05-31 21:42:51 +00:00
Detailed build instructions can be found in the [INSTALL.md ](/INSTALL.md ) file.
2012-10-20 04:22:59 +00:00
2017-11-04 00:02:18 +00:00
## System Requirements
2017-10-29 15:58:19 +00:00
On desktop, the integrated Googlemaps feature of Subsurface requires a GPU
driver that has support for at least OpenGL 2.1. If your driver does not
support that, you may have to run Subsurface in software renderer mode.
Subsurface will automatically attempt to detect this scenario, but in case
2020-04-27 19:42:03 +00:00
it doesn't you may have to enable the software renderer manually with
2017-10-29 15:58:19 +00:00
the following:
1) Learn how to set persistent environment variables on your OS
2) Set the environment variable 'QT_QUICK_BACKEND' with the value of 'software'
2017-11-04 00:02:18 +00:00
## Basic Usage
2012-10-20 04:22:59 +00:00
2013-12-14 20:01:09 +00:00
Install and start from the desktop, or you can run it locally from the
build directory:
2012-10-20 04:22:59 +00:00
2014-08-07 20:15:23 +00:00
On Linux:
2017-11-04 00:02:18 +00:00
```
2013-12-14 20:01:09 +00:00
$ ./subsurface
2017-11-04 00:02:18 +00:00
```
2012-10-20 04:22:59 +00:00
2014-08-07 20:15:23 +00:00
On Mac:
2017-11-04 00:02:18 +00:00
```
2014-08-07 20:15:23 +00:00
$ open Subsurface.app
2017-11-04 00:02:18 +00:00
```
2014-08-07 20:15:23 +00:00
Native builds on Windows are not really supported (the official Windows
2020-09-12 17:48:48 +00:00
installers are cross-built on Linux).
2014-08-07 20:15:23 +00:00
2013-12-14 20:01:09 +00:00
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.
2012-10-20 04:22:59 +00:00
If you have a dive computer supported by libdivecomputer, you can just
2013-12-12 03:16:42 +00:00
select "Import from Divecomputer" from the "Import" menu, select which
2020-09-12 17:48:48 +00:00
dive computer you have (and where it is connected if you need to - note
that there's a special selection for Bluetooth dive computers), and click
on "Download".
2013-12-12 03:16:42 +00:00
The latest list of supported dive computers can be found in the file
2014-08-08 04:02:20 +00:00
SupportedDivecomputers.txt.
2013-12-12 03:16:42 +00:00
Much more detailed end user instructions can be found from inside
Subsurface by selecting Help (typically F1). When building from source
2014-08-08 04:02:20 +00:00
this is also available as Documentation/user-manual.html. The
documentation for the latest release is also available on-line
2014-11-18 13:12:40 +00:00
http://subsurface-divelog.org/documentation/
2012-10-22 02:27:14 +00:00
2017-11-04 00:02:18 +00:00
## Contributing
2012-10-20 04:22:59 +00:00
2014-11-14 05:02:46 +00:00
There is a mailing list for developers: subsurface@subsurface-divelog.org
Go to http://lists.subsurface-divelog.org/cgi-bin/mailman/listinfo/subsurface
2012-10-20 04:22:59 +00:00
to subscribe.
2016-12-30 13:28:25 +00:00
If you want to contribute code, please open a pull request with signed-off
2020-04-26 23:36:27 +00:00
commits at https://github.com/Subsurface/subsurface/pulls
2016-12-30 13:28:25 +00:00
(alternatively, you can also send your patches as emails to the developer
2018-04-09 05:59:33 +00:00
mailing list).
2016-12-30 13:28:25 +00:00
Either way, if you don't sign off your patches, 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
2020-09-12 17:48:48 +00:00
to pass it on as an open source patch under the GPLv2 license.
2011-09-06 19:32:51 +00:00
2014-03-03 21:42:57 +00:00
See: http://developercertificate.org/
2011-09-06 19:32:51 +00:00
2011-09-06 21:58:05 +00:00
Also, please write good git commit messages. A good commit message
looks like this:
2017-11-04 13:36:01 +00:00
```
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
2018-12-23 12:38:11 +00:00
Signed-off-by: Your Name < you @ example . com >
2017-11-04 13:36:01 +00:00
```
2011-09-06 21:58:05 +00:00
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,
2014-03-03 21:42:57 +00:00
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..."
2012-10-22 02:27:14 +00:00
2017-11-04 00:02:18 +00:00
## A bit of Subsurface history
2013-02-07 09:46:22 +00:00
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.
2013-12-12 03:16:42 +00:00
2014-12-17 04:33:28 +00:00
In fall of 2012 Dirk Hohndel took over as maintainer of Subsurface.
