aboutsummaryrefslogtreecommitdiffstats
path: root/README
AgeCommit message (Collapse)Author
2013-11-14First stab at updating ReleaseNotes.txt and READMEGravatar Dirk Hohndel
This needs a lot more work. As does the manual that needs a major rewrite. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-10-08Update the README and create an INSTALL file.Gravatar Thiago Macieira
Let the README contain generic information and move the build instructions to the INSTALL file. Signed-off-by: Thiago Macieira <thiago@macieira.org>
2013-10-06Amend OSX homebrew instructions: we're on master nowGravatar Henrik Brautaset Aronsen
Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-10-06Add a guide on how to build Subsurface on MacOSX with Homebrew.Gravatar Henrik Brautaset Aronsen
Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-10-05Mention debian libusb-1.0-0-dev.Gravatar Cristian Ionescu-Idbohrn
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-09-24Document MaxOSX DBUS workaround in the READMEGravatar Robert Helling
This documents the temporary workaround for the libmarblewidget (and plugin) issues on MacOS in the README. Signed-off-by: Robert C. Helling <helling@atdotde.de> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-06-18Typo in README.Gravatar Binoj D
Signed-off-by: Binoj D <dbinoj@gmail.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-24Updated build instructions for MacOSXGravatar Henrik Brautaset Aronsen
Added info about switching from the MacPorts +quartz packages to +x11, as well as adding the Marble and Qt dependencies. Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-18Work around broken Marble on DebianGravatar Dirk Hohndel
This is a major hack. Debian appears to be missing a necessary header file for Marble to work correctly. We include this header file for now and hack the Configure process to recognize that we are on Debian and force using our local copy of the header file in that case. This may be needed on Ubuntu as well. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-18Update README with warning about incomplete state of Qt portGravatar Dirk Hohndel
Also pointing out the issue with building on Debian / Ubuntu at this stage. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-14Hardware updates for README, ReleaseNotes.txt and user-manualGravatar Dirk Hohndel
Decided to split OSTC3 and Petrel in the ReleaseNotes (as the Petrel was already supported in 3.0) and added the Suunto DX as well. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13First stab at updating the REAMDE for 3.1Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-05-13More *-dev packages.Gravatar Cristian Ionescu-Idbohrn
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-03-03Update README, ReleaseNotes and Makefile for 3.0.2Gravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-27README: fix typoGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-27Update the READMEGravatar Dirk Hohndel
We can now build on Debian Squeeze again. We also point to both the stable version and the latest development sources in the README file. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-22REDME: update dependenciesGravatar Robert C. Helling
We also need libxslt1-dev and zlib1g-dev Signed-off-by: Robert Helling <helling@atdotde.de> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-21Some more tweaks to README and ReleaseNotesv3.0Gravatar Dirk Hohndel
Make the two files more consistent, add list of supported dive computers to ReleaseNotes. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19Small context adjustment.Gravatar Cristian Ionescu-Idbohrn
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-19Replaced two utf8 characters with their ascii equivalents.Gravatar Cristian Ionescu-Idbohrn
Char: ' (8217, #o20031, #x2019) point=695 of 8902 (8%) column=63 Char: - (8211, #o20023, #x2013) point=3162 of 8902 (36%) column=36 Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18Update README for 3.0 releaseGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-18Minor updates to the READMEGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16Add some build info on OpenStreetMap maps and GPS positioning.Gravatar Cristian Ionescu-Idbohrn
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-16Cleanup references to openssl packages.Gravatar Cristian Ionescu-Idbohrn
Signed-off-by: Cristian Ionescu-Idbohrn <cristian.ionescu-idbohrn@axis.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-13Small update to README and add preliminary ReleaseNotesGravatar Dirk Hohndel
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-12Add libzip to MacPorts dependenciesGravatar Henrik Brautaset Aronsen
This adds support for SDE imports. The website documentation should be updated as well. Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-02-07Some changes to the README fileGravatar Dirk Hohndel
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>
2013-01-31README: Update names of Debian packages for dependenciesGravatar Carl Worth
Use libglib2.0-dev instead of glib-2.0 and add both libssl-dev and libsoup2.4-dev. Signed-off-by: Carl Worth <cworth@cworth.org> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2013-01-21Add libsoup and osm-gps-map to Mac build instructions.Gravatar Henrik Brautaset Aronsen
Also force py27-pygtk to use the quartz variant, since MacPorts doesn't have variant dependency resolutions. Signed-off-by: Henrik Brautaset Aronsen <subsurface@henrik.synth.no> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-10-22Update the README with better introduction to SubsurfaceGravatar Dirk Hohndel
This is similar to what we have on the website. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-10-21Fix annoying whitespace damage that I just introducedGravatar Dirk Hohndel
Remember: don't push before doing a git log -p Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-10-21Small updates to the READMEGravatar Dirk Hohndel
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>
2012-10-19Updated the README file for 2.1Gravatar Dirk Hohndel
This clearly hadn't been edited in more than a year and was way outdated. I tried to make it useful and informative :-) Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-05-02Move the "Import" function from the File menu to the Log menuGravatar Linus Torvalds
Sure, you can import a file too, but it really makes more sense to have the actions related to importing new logs under "Log", I think. I don't think of it as a file operation. Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-11-27README spelling, capitalizationGravatar Joachim Schipper
Spelling: paragrahps -> paragraphs. Update the README's example commit message to start with a capital letter. Capitalize "Java". Signed-off-by: Joachim Schipper <joachim@joachimschipper.nl>
2011-09-27Add note on dive computers using the same import engineGravatar Linus Torvalds
Lots of dive computers are just variations on a theme, or sometimes even just rebadged copies of each others with different manufacturer and model names. The import dialog may not mention your exact dive computer by name, but that doesn't necessarily mean that you cannot import data from it. Make that clearer in the README, and list the rough list of dive computers supported by libdivecomputer. Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-09-26Update README to reflect the fact that /dev/ttyUSB0 is no longer hardcodedGravatar Linus Torvalds
Yay. It's not like we're all done, but the hardcoded dive computer location was one of those "I don't want to release 1.0 with this". Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-09-22Update the README a bitGravatar Linus Torvalds
Update for the current library situation, and notes about libdivecomputer installation location. And remove the "we don't interface directly with libdivecomputer", since that is obviously not true any more. Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-09-20Separate out the UI from the program logicGravatar Dirk Hohndel
The following are UI toolkit specific: gtk-gui.c - overall layout, main window of the UI divelist.c - list of dives subsurface maintains equipment.c - equipment / tank information for each dive info.c - detailed dive info print.c - printing The rest is independent of the UI: main.c i - program frame dive.c i - creates and maintaines the internal dive list structure libdivecomputer.c uemis.c parse-xml.c save-xml.c - interface with dive computers and the XML files profile.c - creates the data for the profile and draws it using cairo This commit should contain NO functional changes, just moving code around and a couple of minor abstractions. Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2011-09-15Rename the project 'subsurface'Gravatar Linus Torvalds
I never really liked 'diveclog' as a name - it's not like the C part is all that important. And while I could try to just make up another slang word for despicable person (in the tradition of naming all my projects after myself), I just can't see it. So let's just call it "subsurface". Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-09-12Update the README about libdivecomputerGravatar Linus Torvalds
The build instructions are in the git commit log too, but let's make them a bit easier to find. Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-09-08Save default units using GConfGravatar Linus Torvalds
That seems to be the gtk2 way. Whatever. diveclog ends up defaulting to metric units, because we all know that's the right thing to do. However, I learnt to dive in the US, so I'm used to seeing psi and feet. So despite the sane defaults, I want diveclog to use the broken imperial units for me. Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-09-06Add some information about properly formatted commit messagesGravatar Linus Torvalds
It does seem like a lot of github users are not used to good commit message rules, and may never have used git for a project that actually cares about good logs and nice summary lines. Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-09-06Add more explicit contributing explanationGravatar Scott Chacon
Most developers on GitHub are not used to projects that use the Signed-off-by convention. They do, however, tend to read the READMEs to see which conventions the author prefers to follow. If you are explicit about what you prefer in the README with easy to follow instructions, it is more likely people will follow those conventions. Signed-off-by: Scott Chacon <schacon@gmail.com>
2011-09-03Update README a bitGravatar Linus Torvalds
..since this is now on github, might as well tell people what they need to compile it, and warn them about the state of the project. Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2011-09-01Rename some files to be more appropriateGravatar Linus Torvalds
The executable is now called 'divelog'. If this gets useful enough to actually *use*, I guess I'll have to come up with a real name some day. Add a silly README, rename 'parse' to 'parse-xml'. Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>