Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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