mirror of
https://github.com/subsurface/subsurface.git
synced 2025-02-19 22:16:15 +00:00
Convert README to markdown and add Travis CI build status, closes #765
This commit is contained in:
parent
ac25b238dd
commit
f296a81a14
1 changed files with 19 additions and 18 deletions
155
README.md
Normal file
155
README.md
Normal file
|
@ -0,0 +1,155 @@
|
|||
# Subsurface [](https://travis-ci.org/Subsurface-divelog/subsurface)
|
||||
|
||||
This is the README file for Subsurface 4.7.2
|
||||
|
||||
Please check the `ReleaseNotes.txt` for details about new features and
|
||||
changes since Subsurface 4.6.4 (and earlier versions).
|
||||
|
||||
Subsurface can be found at http://subsurface-divelog.org
|
||||
|
||||
Our user forum is at http://subsurface-divelog.org/user-forum/
|
||||
|
||||
Report bugs and issues at
|
||||
https://github.com/Subsurface-divelog/subsurface/issues
|
||||
|
||||
License: GPLv2
|
||||
|
||||
We frequently make new test versions of Subsurface avilable at
|
||||
http://subsurface-divelog.org/downloads/test/
|
||||
These tend to contain the latest bug fixes and features, but also
|
||||
occasionally the latest bugs and issues. Please understand when using them
|
||||
that these are primarily intended for testing.
|
||||
|
||||
You can get the sources to the latest development version from the git
|
||||
repository:
|
||||
|
||||
```
|
||||
git clone https://github.com/Subsurface-divelog/subsurface.git
|
||||
```
|
||||
|
||||
You can also fork the repository and browse the sources at the same site,
|
||||
simply using https://github.com/Subsurface-divelog/subsurface
|
||||
|
||||
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.7.2 (or whatever the last release is)
|
||||
```
|
||||
|
||||
or download a tarball from http://subsurface-divelog.org/downloads/Subsurface-4.7.2.tgz
|
||||
|
||||
Detailed build instructions can be found in the INSTALL file.
|
||||
|
||||
## System Requirements
|
||||
|
||||
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
|
||||
in doesn't you may have to enable the software renderer manually with
|
||||
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'
|
||||
|
||||
## 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 open a pull request with signed-off
|
||||
commits at https://github.com/Subsurface-divelog/subsurface/pulls
|
||||
(alternatively, you can also send your patches as emails to the developer
|
||||
mailing lsit).
|
||||
|
||||
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
|
||||
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.
|
Loading…
Add table
Add a link
Reference in a new issue