mirror of
				https://github.com/subsurface/subsurface.git
				synced 2025-02-19 22:16:15 +00:00 
			
		
		
		
	First stab at updating the REAMDE for 3.1
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This commit is contained in:
		
							parent
							
								
									db95261d56
								
							
						
					
					
						commit
						06712b29e3
					
				
					 1 changed files with 31 additions and 26 deletions
				
			
		
							
								
								
									
										57
									
								
								README
									
										
									
									
									
								
							
							
						
						
									
										57
									
								
								README
									
										
									
									
									
								
							| 
						 | 
					@ -25,17 +25,17 @@ in more than a dozen languages and well supported by an active
 | 
				
			||||||
developer community.
 | 
					developer community.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
One of the major strengths of Subsurface is its support of a wide range
 | 
					One of the major strengths of Subsurface is its support of a wide range
 | 
				
			||||||
of dive computers (most common dive computers are supported, a
 | 
					of dive computers (most common dive computers are supported with the help
 | 
				
			||||||
detailed list is at
 | 
					of libdivecomputer); a detailed list is at
 | 
				
			||||||
http://subsurface.hohndel.org/documentation/supported-dive-computers).
 | 
					http://subsurface.hohndel.org/documentation/supported-dive-computers).
 | 
				
			||||||
Subsurface can also import existing dive logs from several sources
 | 
					Subsurface can also import existing dive logs from several sources
 | 
				
			||||||
including MacDive, Suunto DM3, JDiveLog and divelogs.de. Another
 | 
					including MacDive, Suunto DM3/DM4, JDiveLog and divelogs.de. Another
 | 
				
			||||||
strength is its ability to visualize the depth profile (and, if
 | 
					strength is its ability to visualize the depth profile (and, if
 | 
				
			||||||
available, the tank pressure curve) in very innovative ways that give
 | 
					available, the tank pressure curve) in very innovative ways that give
 | 
				
			||||||
the user additional information on relative velocity (and momentary
 | 
					the user additional information on relative velocity (and momentary
 | 
				
			||||||
air consumption) during the dive through the coloring of the graphs.
 | 
					air consumption) during the dive through the coloring of the graphs.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
The latest public version is Subsurface 3.0, released in February of 2013.
 | 
					The latest public version is Subsurface 3.1, released in May of 2013.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
License: GPLv2
 | 
					License: GPLv2
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -51,40 +51,38 @@ You can also browse the sources via gitweb at git.hohndel.org
 | 
				
			||||||
If you want the latest release (instead of the bleeding edge
 | 
					If you want the latest release (instead of the bleeding edge
 | 
				
			||||||
development version) you can either get this via
 | 
					development version) you can either get this via
 | 
				
			||||||
 | 
					
 | 
				
			||||||
git checkout v3.0.2  (or whatever the last release is)
 | 
					git checkout v3.1  (or whatever the last release is)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
if you have already cloned the git repository as shown above or you
 | 
					if you have already cloned the git repository as shown above or you
 | 
				
			||||||
can get a tar ball from
 | 
					can get a tar ball from
 | 
				
			||||||
 | 
					
 | 
				
			||||||
http://subsurface.hohndel.org/downloads/Subsurface-3.0.2.tgz
 | 
					http://subsurface.hohndel.org/downloads/Subsurface-3.1.tgz
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Building subsurface under Linux
 | 
					Building subsurface under Linux
 | 
				
			||||||
-------------------------------
 | 
					-------------------------------
 | 
				
			||||||
You need libxml2-devel, libxslt-devel, gtk2-devel, glib-2.0,
 | 
					You need libxml2-devel, libxslt-devel, gtk2-devel, glib2-devel,
 | 
				
			||||||
gconf2-devel, libsoup-devel to build this (and libusb-1.0 if you have
 | 
					gconf2-devel, libsoup-devel, osm-gps-map-devel, libsqlite3x-devel, and
 | 
				
			||||||
libdivecomputer built with it, but then you obviously already have it
 | 
					libzip-devel to build this (and libusb-1.0 if you have libdivecomputer
 | 
				
			||||||
installed). Check with your Linux distribution how to install these
 | 
					built with it, but then you obviously already have it installed).
 | 
				
			||||||
packages.
 | 
					Check with your Linux distribution how to install these packages.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
On Debian the package names are different; try libxml2-dev,
 | 
					On Debian the package names are different; try libxml2-dev,
 | 
				
			||||||
libgtk2.0-dev, libglib2.0-dev, libgconf2-dev, libsoup2.4-dev,
 | 
					libgtk2.0-dev, libglib2.0-dev, libgconf2-dev, libsoup2.4-dev,
 | 
				
			||||||
libsqlite3-dev, libxslt1-dev, libzip-dev, zlib1g-dev.
 | 
					libosmgpsmap-dev, libsqlite3-dev, libxslt1-dev, libzip-dev,
 | 
				
			||||||
 | 
					zlib1g-dev.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
To be able to visualise the dives on a map (optional), using GPS
 | 
					Note that contrary to earlier versions of Subsurface, starting in v3.1
 | 
				
			||||||
coordinates, install the osm-gps-map-devel (Fedora) or libosmgpsmap-dev
 | 
					XSLT, LIBZIP and OSMGPSMAP are no longer optional but instead are
 | 
				
			||||||
(Debian) package. That will be detected and configured at build
 | 
					required to build.
 | 
				
			||||||
time. The library is used to embed maps in applications that, when
 | 
					 | 
				
			||||||
given GPS co-ordinates, draw a GPS track.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
You also need to have libdivecomputer installed. The current git
 | 
					You also need to have libdivecomputer installed. The current git
 | 
				
			||||||
versions of Subsurface assume that you use libdivecomputer version
 | 
					versions of Subsurface assume that you use libdivecomputer version
 | 
				
			||||||
0.3, which goes something like this:
 | 
					0.4, which goes something like this:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
git clone \
 | 
					git clone git://git.libdivecomputer.org/libdivecomputer
 | 
				
			||||||
git://libdivecomputer.git.sourceforge.net/gitroot/libdivecomputer/libdivecomputer
 | 
					 | 
				
			||||||
cd libdivecomputer
 | 
					cd libdivecomputer
 | 
				
			||||||
git checkout release-0.3
 | 
					git checkout release-0.4
 | 
				
			||||||
autoreconf --install
 | 
					autoreconf --install
 | 
				
			||||||
./configure
 | 
					./configure
 | 
				
			||||||
make
 | 
					make
 | 
				
			||||||
| 
						 | 
					@ -104,6 +102,11 @@ cross builds under Linux (currently on Fedora 17). A shell script to do
 | 
				
			||||||
that (plus the .nsi file to create the installer with makensis) are
 | 
					that (plus the .nsi file to create the installer with makensis) are
 | 
				
			||||||
included in the packaging/Windows directory.
 | 
					included in the packaging/Windows directory.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Strangely the developers have failed to make 'https' support work in
 | 
				
			||||||
 | 
					the cross-built Windows binaries. As a workaround at this point the
 | 
				
			||||||
 | 
					cross built Windows binaries use http instead https connections (right
 | 
				
			||||||
 | 
					now this only applies to divelogs.de uploads).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
The best way to get libdivecomputer to build appears to be
 | 
					The best way to get libdivecomputer to build appears to be
 | 
				
			||||||
 | 
					
 | 
				
			||||||
mingw32-configure
 | 
					mingw32-configure
 | 
				
			||||||
| 
						 | 
					@ -126,8 +129,9 @@ sudo port install gtk2 +quartz py27-pygtk +quartz libusb gtk-osx-application \
 | 
				
			||||||
     automake autoconf libtool libsoup osm-gps-map libzip
 | 
					     automake autoconf libtool libsoup osm-gps-map libzip
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Install libdivecomputer:
 | 
					Install libdivecomputer:
 | 
				
			||||||
git clone git://libdivecomputer.git.sourceforge.net/gitroot/libdivecomputer/libdivecomputer
 | 
					git clone git://git.libdivecomputer.org/libdivecomputer
 | 
				
			||||||
cd libdivecomputer
 | 
					cd libdivecomputer
 | 
				
			||||||
 | 
					git checkout release-0.4
 | 
				
			||||||
autoreconf --install
 | 
					autoreconf --install
 | 
				
			||||||
LIBUSB_CFLAGS=-I/opt/local/include ./configure
 | 
					LIBUSB_CFLAGS=-I/opt/local/include ./configure
 | 
				
			||||||
make
 | 
					make
 | 
				
			||||||
| 
						 | 
					@ -162,24 +166,25 @@ computer you have (and where it is connected if you need to), and hit
 | 
				
			||||||
The latest list of supported dive computers can be found at
 | 
					The latest list of supported dive computers can be found at
 | 
				
			||||||
http://subsurface.hohndel.org/documentation/supported-dive-computers/
 | 
					http://subsurface.hohndel.org/documentation/supported-dive-computers/
 | 
				
			||||||
 | 
					
 | 
				
			||||||
At the time of the 3.0 release they were:
 | 
					At the time of the 3.1 release they were:
 | 
				
			||||||
Atomics Aquatics
 | 
					Atomics Aquatics
 | 
				
			||||||
	Cobalt
 | 
						Cobalt
 | 
				
			||||||
Cressi / Zeagle / Mares
 | 
					Cressi / Zeagle / Mares
 | 
				
			||||||
	Edy, Nemo Sport
 | 
						Edy, Nemo Sport
 | 
				
			||||||
	N2iTiON3
 | 
						N2iTiON3
 | 
				
			||||||
 | 
						Leonardo
 | 
				
			||||||
Mares
 | 
					Mares
 | 
				
			||||||
	Nemo, Nemo Excel, Nemo Apneist,...
 | 
						Nemo, Nemo Excel, Nemo Apneist,...
 | 
				
			||||||
	Puck, Puck Air, Nemo Air, Nemo Wide,...
 | 
						Puck, Puck Air, Nemo Air, Nemo Wide,...
 | 
				
			||||||
	Darwin, Darwin Air, M1, M2, Airlab
 | 
						Darwin, Darwin Air, M1, M2, Airlab
 | 
				
			||||||
	Icon HD, Icon HD Net Ready, Nemo Wide 2
 | 
						Icon HD, Icon HD Net Ready, Nemo Wide 2
 | 
				
			||||||
Oceanic / Aeris / Sherwood / Hollis / Genesis / Tusa (Pelagic)
 | 
					Oceanic / Aeris / Sherwood / Hollis / Genesis / Tusa (Pelagic)
 | 
				
			||||||
	VT Pro, Versa Pro, Pro Plus 2, Wisdom, Atmos 2, Atmos AI, Atmos Elite,...
 | 
						VT Pro, Versa Pro, Pro Plus 2, Pro Plus 3, Wisdom, Atmos 2, Atmos AI, Atmos Elite,...
 | 
				
			||||||
	Veo 250, Veo 180Nx, XR2, React Pro, DG02, Insight,...
 | 
						Veo 250, Veo 180Nx, XR2, React Pro, React Pro White, DG02, Insight,...
 | 
				
			||||||
	Atom 2.0, VT3, Datamask, Geo, Geo 2.0, Veo 2.0, Veo 3.0, Pro Plus 2.1,
 | 
						Atom 2.0, VT3, Datamask, Geo, Geo 2.0, Veo 2.0, Veo 3.0, Pro Plus 2.1,
 | 
				
			||||||
	Compumask, Elite T3, Epic, Manta, IQ-900 (Zen), IQ-950 (Zen Air), IQ-750 (Element II),...
 | 
						Compumask, Elite T3, Epic, Manta, IQ-900 (Zen), IQ-950 (Zen Air), IQ-750 (Element II),...
 | 
				
			||||||
Heinrichs Weikamp
 | 
					Heinrichs Weikamp
 | 
				
			||||||
	OSTC, OSTC Mk.2, OSTC 2N
 | 
						OSTC, OSTC Mk.2, OSTC 2N, OSTC3
 | 
				
			||||||
	Frog
 | 
						Frog
 | 
				
			||||||
Reefnet
 | 
					Reefnet
 | 
				
			||||||
	Sensus
 | 
						Sensus
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue