
guitone - a Qt-Frontend for monotone
====================================

Guitone is a frontend to monotone. It implements the monotone automation
interface, so its likely that it won't do things which aren't implemented there
(currently for example workspace actions like update and commit).

You need Qt >= 4.2 to build and monotone >= 0.34 (or a monotone with
an interface version of 4.1 or greater) to run guitone. Earlier
versions do not have all the infrastructure for certain functionalities
available, but might still work in some areas. (You have to lower the 
requirements in Monotone.cpp before to make it actually work with older
versions.)

To build under Linux / Mac OS X just do

 $ cd /path/to/guitone
 $ ./build.sh

On Mac OS X you need the Sparkle framework (http://sparkle.andymatuschak.org/)
installed to build guitone. Make sure it does reside outside 
/System/Library/Frameworks if you plan to build with the univsersal SDK
(the default).
You can also build guitone with Xcode on Mac OS X. For this to work you should
have a recent version of Xcode installed (>= 2.3 because of gcc bugs) which is
usually found somewhere on the installation DVD. Then you can create a Xcode
project file with

 $ qmake -spec macx-xcode

and open this with Xcode. If you need to tweak settings (i.e. architecture)
in the Qt project file (guitone.pro), remember to redo this step.

The created binary can be found in bin/. 

If you like to build on Windows, all you need is a working version of 
Qt 4.2.x. Please check the docs at trolltech.com for assistance how to
build Qt on Windows. 
After that get the sources of guitone, unpack them into some directory
and run qmake in it. Then start your favourite make tool and you're done.


The most recent version can always be obtained from the monotone 
repository on venge.net/monotone. guitone is located in the branch 
net.venge.monotone.guitone.


Program Notes
=============

* If you encounter crashes, make sure that you've cleaned out any old 
  settings directory, usually under .config/GUITONE or (in newer versions)
  under .config/Thomas\ Keller\. Newer versions of guitone save their
  settings according to their platform, that means that the config file
  on MacOS X is ~/Library/Preferences/biz.thomaskeller.guitone.conf.
  Under Win32 the registry is used.

* If you still encounter crashes try to enable the file log in the
  Preferences dialog. The log is usually saved in your home directory,
  named guitone.log. Please send this file, together with a description
  what you've done and (optionally) a gdb backtrace to one of the authors.


Platform Notes
==============

* If you like to compile guitone on Mac OS X, make sure you've
  updated your gcc to 4.0.1 or newer which comes with XCode
  2.2 or later. Otherwise you'll get a "Bus error" on runtime
  due to a bug in gcc 4.0.0

* If you encounter segfaults and other weird crashs on Linux when
  closing dialogs please ensure you've a recent enought Qt version.
  Apparently in 4.2.2 the problem is no longer present.

* If you run guitone on Win32 without administration privileges you
  might encounter problems while loading the workspace' inventory.
  The only known workaround here is to run guitone with
  administration privileges.

Known Bugs
==========

* If you try to open a database or workspace in Mac OS X through Finder
  and guitone is not yet running, you'll receive a deadlock. We're
  currently investigating this issue.

* After you committed a revision, your workspace is not updated, simply
  because there is no monotone automation command available for this. In the
  meantime you just have to reload your workspace after a commit.

* The Update Workspace dialog is currently a stub for the same reason and
  won't do anything.

* if your problem is not described here, take a look at the task list on
  http://guitone.thomaskeller.biz/g/tracker


Authors
=======

Thomas "TommyD" Keller <me AT thomaskeller DOT biz>
Ingo "Slinky" Maindorfer <ingo AT liquidcooling DOT de>
Jean-Louis "Ganwell" Fuchs <ganwell AT fangorn DOT ch>

Contributions are very welcome, we're usually hanging around in the monotone
IRC at irc://irc.oftc.net/#monotone so don't hesitate to contact us!

