source: subsurface/README.md

Last change on this file was d0dcac2, checked in by Dirk Hohndel <dirk@…>, 3 weeks ago

Getting ready for Subsurface 4.7.6

Signed-off-by: Dirk Hohndel <dirk@…>

  • Property mode set to 100644
File size: 5.7 KB
Line 
1# Subsurface [![Build Status](https://travis-ci.org/Subsurface-divelog/subsurface.svg?branch=master)](https://travis-ci.org/Subsurface-divelog/subsurface)
2
3This is the README file for Subsurface 4.7.6
4
5Please check the `ReleaseNotes.txt` for details about new features and
6changes since Subsurface 4.7.5 (and earlier versions).
7
8Subsurface can be found at http://subsurface-divelog.org
9
10Our user forum is at http://subsurface-divelog.org/user-forum/
11
12Report bugs and issues at
13https://github.com/Subsurface-divelog/subsurface/issues
14
15License: GPLv2
16
17We frequently make new test versions of Subsurface avilable at
18http://subsurface-divelog.org/downloads/test/
19These tend to contain the latest bug fixes and features, but also
20occasionally the latest bugs and issues. Please understand when using them
21that these are primarily intended for testing.
22
23You can get the sources to the latest development version from the git
24repository:
25
26```
27git clone https://github.com/Subsurface-divelog/subsurface.git
28```
29
30You can also fork the repository and browse the sources at the same site,
31simply using https://github.com/Subsurface-divelog/subsurface
32
33If you want the latest release (instead of the bleeding edge
34development version) you can either get this via git or the release tar
35ball. After cloning run the following command:
36
37```
38git checkout v4.7.6  (or whatever the last release is)
39```
40
41or download a tarball from http://subsurface-divelog.org/downloads/Subsurface-4.7.6.tgz
42
43Detailed build instructions can be found in the INSTALL file.
44
45## System Requirements
46
47On desktop, the integrated Googlemaps feature of Subsurface requires a GPU
48driver that has support for at least OpenGL 2.1. If your driver does not
49support that, you may have to run Subsurface in software renderer mode.
50
51Subsurface will automatically attempt to detect this scenario, but in case
52in doesn't you may have to enable the software renderer manually with
53the following:
541) Learn how to set persistent environment variables on your OS
552) Set the environment variable 'QT_QUICK_BACKEND' with the value of 'software'
56
57## Basic Usage
58
59Install and start from the desktop, or you can run it locally from the
60build directory:
61
62On Linux:
63
64```
65$ ./subsurface
66```
67
68On Mac:
69
70```
71$ open Subsurface.app
72```
73
74Native builds on Windows are not really supported (the official Windows
75installers are both cross-built on Linux).
76
77You can give a data file as command line argument, or (once you have
78set this up in the Preferences) Subsurface picks a default file for
79you when started from the desktop or without an argument.
80
81If you have a dive computer supported by libdivecomputer, you can just
82select "Import from Divecomputer" from the "Import" menu, select which
83dive computer you have (and where it is connected if you need to), and
84hit "OK".
85
86The latest list of supported dive computers can be found in the file
87SupportedDivecomputers.txt.
88
89Much more detailed end user instructions can be found from inside
90Subsurface by selecting Help (typically F1). When building from source
91this is also available as Documentation/user-manual.html. The
92documentation for the latest release is also available on-line
93http://subsurface-divelog.org/documentation/
94
95## Contributing
96
97There is a mailing list for developers: subsurface@subsurface-divelog.org
98Go to http://lists.subsurface-divelog.org/cgi-bin/mailman/listinfo/subsurface
99to subscribe.
100
101If you want to contribute code, please open a pull request with signed-off
102commits at https://github.com/Subsurface-divelog/subsurface/pulls
103(alternatively, you can also send your patches as emails to the developer
104mailing lsit).
105
106Either way, if you don't sign off your patches, we will not accept them.
107This means adding a line that says "Signed-off-by: Name <email>" at the
108end of each commit, indicating that you wrote the code and have the right
109to pass it on as an open source patch.
110
111See: http://developercertificate.org/
112
113Also, please write good git commit messages.  A good commit message
114looks like this:
115
116```
117Header line: explain the commit in one line (use the imperative)
118
119Body of commit message is a few lines of text, explaining things
120in more detail, possibly giving some background about the issue
121being fixed, etc etc.
122
123The body of the commit message can be several paragraphs, and
124please do proper word-wrap and keep columns shorter than about
12574 characters or so. That way "git log" will show things
126nicely even when it's indented.
127
128Make sure you explain your solution and why you're doing what you're
129doing, as opposed to describing what you're doing. Reviewers and your
130future self can read the patch, but might not understand why a
131particular solution was implemented.
132
133Reported-by: whoever-reported-it
134Signed-off-by: Your Name <youremail@yourhost.com>
135```
136
137where that header line really should be meaningful, and really should be
138just one line.  That header line is what is shown by tools like gitk and
139shortlog, and should summarize the change in one readable line of text,
140independently of the longer explanation. Please use verbs in the
141imperative in the commit message, as in "Fix bug that...", "Add
142file/feature ...", or "Make Subsurface..."
143
144## A bit of Subsurface history
145
146In fall of 2011, when a forced lull in kernel development gave him an
147opportunity to start on a new endeavor, Linus Torvalds decided to tackle
148his frustration with the lack of decent divelog software on Linux.
149
150Subsurface is the result of the work of him and a team of developers since
151then. It now supports Linux, Windows and MacOS and allows data import from
152a large number of dive computers and several existing divelog programs. It
153provides advanced visualization of the key information provided by a
154modern dive computer and allows the user to track a wide variety of data
155about their diving.
156
157In fall of 2012 Dirk Hohndel took over as maintainer of Subsurface.
Note: See TracBrowser for help on using the repository browser.