source: subsurface/README

v4.6.4
Last change on this file was 92e6cdf, checked in by Dirk Hohndel <dirk@…>, 4 months ago

Update README for 4.6.4 release

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

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