Some changes to the README file

This is not getting us ready for 3.0, it mostly fixes some of the obvious
errors in there that were correct for Subsurface 2.1 but clearly are no
longer true (like the suggestion to specifically check out libdivecomputer
0.2.0).

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This commit is contained in:
Dirk Hohndel 2013-02-07 20:46:22 +11:00
parent 67604ccae3
commit 3638da6fac

61
README
View file

@ -1,29 +1,24 @@
Subsurface - an Open Source Divelog Subsurface - an Open Source Divelog
=================================== ===================================
In fall of 2011, when a forced lull in kernel development gave him an Subsurface is able to track multi-tank dives with air, Nitrox or
opportunity to start on a new endeavor, Linus Torvalds decided to tackle TriMix. It keeps track of equipment like weights and exposure
his frustration with the lack of decent divelog software on Linux. protection used, tracks the dice locations (if available including GPS
fixes), dive masters and dive buddies and allows the user to rate
Subsurface is the result of the work of him and a team of developers since dives and provide additional dive notes. It calculates a wide variety
then. It now supports Linux, Windows and MacOS and allows data import from of statistics of the user's diving and calculates and tracks
a large number of dive computers and several existing divelog programs. It information like SAC rate, partial pressures of O2, N2 and H2,
provides advanced visualization of the key information provided by a calculated deco information, and many more.
modern dive computer and allows the user to track a wide variety of data
about their diving.
Subsurface is able to track multi-tank dives with air, Nitrox or TriMix,
weights and exposure protection used, dive masters and dive buddies and
allows the user to rate dives and provide additional dive notes. It
calculates a wide variety of statistics of the user's diving and
calculates and tracks information like SAC rate or OTU.
Subsurface allows the user to print out a detailed log book including dive Subsurface allows the user to print out a detailed log book including dive
profiles and other relevant information. The program is localized in about profiles and other relevant information. The program is localized in about
a dozen languages and well supported by an active developer community. In a dozen languages and well supported by an active developer community.
fall of 2012 Dirk Hohndel has taken over as Subsurface maintainer.
The latest version is Subsurface 2.1, released in October of 2012. You are reading the README file of the latest git version, this file
is not tracked as actively as might be desirable, so some of the
information here may be outdated.
The latest public version is Subsurface 2.1, released in October of 2012.
License: GPLv2 License: GPLv2
@ -42,22 +37,24 @@ You can also browse the sources via gitweb.
Building subsurface under Linux Building subsurface under Linux
------------------------------- -------------------------------
You need libxml2-devel, gtk2-devel, glib-2.0 and gconf2-devel to build You need libxml2-devel, libxslt-devel, gtk2-devel, glib-2.0,
this (and libusb-1.0 if you have libdivecomputer built with it, but then gconf2-devel, libssl-devel, libsoup-devel to build this (and
you obviously already have it installed). Check with your Linux libusb-1.0 if you have libdivecomputer built with it, but then you
obviously already have it installed). Check with your Linux
distribution how to install these packages. distribution how to install these packages.
On Debian the package names are different; try libxml2-dev libgtk2.0-dev On Debian the package names are different; try libxml2-dev libgtk2.0-dev
libglib2.0-dev libgconf2-dev libssl-dev libsoup2.4-dev, but it seems libglib2.0-dev libgconf2-dev libssl-dev libsoup2.4-dev, but it seems
the cairo package at least in Squeeze is too old. the cairo package at least in Squeeze is too old.
You also need to have libdivecomputer version 0.2 installed, which goes You also need to have libdivecomputer installed. The current git
something like this: versions of Subsurface assume that you use libdivecomputer version
0.3, which goes something like this:
git clone \ git clone \
git://libdivecomputer.git.sourceforge.net/gitroot/libdivecomputer/libdivecomputer git://libdivecomputer.git.sourceforge.net/gitroot/libdivecomputer/libdivecomputer
cd libdivecomputer cd libdivecomputer
git checkout v0.2.0 git checkout v0.3.0
autoreconf --install autoreconf --install
./configure ./configure
make make
@ -252,3 +249,17 @@ CREDITS:
This file was originally started by Linus. This file was originally started by Linus.
The initial instructions for building on a Mac were provided by Henrik Brautaset Aronsen The initial instructions for building on a Mac were provided by Henrik Brautaset Aronsen
Jef Driessen helped creating the cross-building instructions for Windows Jef Driessen helped creating the cross-building instructions for Windows
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.