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

Guitone is a frontend to the monotone revision control system. It aims towards
a full implementation of the monotone automation interface and is especially
targeted at beginners. Guitone is copylefted under the terms of the GNU General
Public License Version 3, or, at your option, any later version of this license.

You need Qt >= 4.5.0 to build and monotone >= 0.46 (or a monotone with an
interface version of 12.0 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 the project
file and rebuild monotone before you can actually make it work with older
versions - but this is not recommended.)

To build under Linux / Mac OS X, just do

 $ cd /path/to/guitone
 $ lrelease guitone.pro
 $ qmake -config release
 $ make

You can also build guitone with Xcode on Mac OS X. You should have a recent
version of Xcode installed (>= 2.2 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. Please check the docs at trolltech.com for assistance how to build and / or
install 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 guitone
repository at thomaskeller.biz. guitone is located in the branch
net.venge.monotone.guitone:

 $ mtn db init -d guitone.mtn
 $ mtn pull -d guitone.mtn thomaskeller.biz "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 under 
  .config/Thomas\ Keller. Newer versions of guitone save their
  settings according to the underlying platform, ie. as config file
  under Mac OS X (~/Library/Preferences/biz.thomaskeller.guitone.conf) or
  in the registry under Windows.

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

* If column sizes in the file diff dialog aren't properly sized and
  any resize attempts are not remembered, please open guitone's
  configuration and remove any entry for 'diffView_header' manually.
  You can find the configuration in
    $HOME/.config/Thomas\ Keller/guitone.conf
  on Linux / Unix, in
    $HOME/Library/Preferences/biz.thomaskeller.guitone.plist
  on Mac OS X and finally in the registry under
    HKEY_CURRENT_USER\Software\Thomas Keller\guitone
  if you're using a Windows build.


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


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

* If you try an anonymous pull after you tried a pull with a specific key,
  the anonymous one might fail with "Key 'abc...' is unknown to server" as
  well, because monotone 0.46 has a bug which prevents the resetting of global
  options such as --key between stdio commands.

* When you switch one workspace to another revision, old paths might still
  pop up in the workspace view on Mac OS X. The reason for that is because
  Qt doesn't properly resets / clears the attached views if a model is hard
  reset. Clicking on these "ghost" items should remove them.

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


Author
======

Thomas "tommyd" Keller <me AT thomaskeller DOT biz>

Contributions are very welcome, I'm usually hanging around in the
oftc and freenode networks (nick: tommyd), so don't hesitate to contact me!


Former Contributors
===================

Ingo "Slinky" Maindorfer <ingo AT liquidcooling DOT de>
Jean-Louis "Ganwell" Fuchs <ganwell AT fangorn DOT ch>