Small updates to the README

Mention the specific libdivecomputer version needed (0.2).
References to additional documentation.
Remove distracting info from the flow of the text and add a Credits section at
the end.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This commit is contained in:
Dirk Hohndel 2012-10-21 19:27:14 -07:00
parent 79d204dde8
commit c9226758d4

43
README
View file

@ -1,5 +1,4 @@
Subsurface - an Open Source Divelog Subsurface - an Open Source Divelog ===================================
===================================
In fall of 2011, when a forced lull in kernel development gave him an 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 opportunity to start on a new endeavor, Linus Torvalds decided to tackle
@ -34,11 +33,13 @@ On Debian the package names are different; try libxml2-dev libgtk2.0-dev
glib-2.0 libgconf2-dev, but it seems the cairo package at least in glib-2.0 libgconf2-dev, but it seems the cairo package at least in
Squeeze is too old. Squeeze is too old.
You also need to have libdivecomputer installed, which goes something like this: You also need to have libdivecomputer version 0.2 installed, 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
autoreconf --install autoreconf --install
./configure ./configure
make make
@ -64,25 +65,14 @@ mingw32-configure
mingw32-make mingw32-make
sudo mingw32-make install sudo mingw32-make install
Jef Driesen, the developer behind libdivecomputer, provided his build Once you have built and installed libdivecomputer you can use
instructions on Windows (which are different from what I use):
./configure --host=i586-mingw32msvc --prefix=$HOME/local sh packaging/Windows/mingw-make.sh
PKG_CONFIG_LIBDIR='/opt/i586-mingw32msvc/lib/pkgconfig'
make
make install
These use different paths than what I get on Fedora. To do this the way to then build subsurface.
Jef does I would need
PKG_CONFIG_LIBDIR='/usr/i686-w64-mingw32/sys-root/mingw/lib/pkgconfig'
Either way, once you have built libdivecomputer you can use sh
packaging/Windows/mingw-make.sh to then build subsurface.
Building subsurface on a Mac Building subsurface on a Mac
----------------------------
Provided by Henrik Brautaset Aronsen
Install MacPorts and install the dependencies from MacPorts: Install MacPorts and install the dependencies from MacPorts:
sudo port install gtk2 +no_x11 +quartz -x11 libusb gtk-osx-application \ sudo port install gtk2 +no_x11 +quartz -x11 libusb gtk-osx-application \
automake autoconf libtool automake autoconf libtool
@ -101,9 +91,12 @@ cd subsurface
PKG_CONFIG_PATH="/usr/local/lib/pkgconfig/" make PKG_CONFIG_PATH="/usr/local/lib/pkgconfig/" make
sudo make install-macosx sudo make install-macosx
More instructions on how to create a Subsurface DMG can be found in
packaging/macosx/README
Usage: Usage:
------ ======
Install and start from the desktop (or you can run it locally from the Install and start from the desktop (or you can run it locally from the
build directory). build directory).
@ -192,6 +185,8 @@ Atomic Aquatics:
* Cobalt * Cobalt
More detailed end user instructions can be found at Documentation/user-manual.html
Contributing: Contributing:
------------- -------------
@ -230,3 +225,13 @@ 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 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, shortlog, and should summarize the change in one readable line of text,
independently of the longer explanation. independently of the longer explanation.
CREDITS:
========
This file was originally started by Linus.
The initial instructions for building on a Mac were provided by Henrik Brautaset Aronsen
Jef Driessen helped creating the cross-building instructions for Windows