annotate README.txt @ 587:4ed384ea7f39 fswatcher

comment only
author Chris Cannam
date Wed, 14 Mar 2012 12:00:20 +0000
parents 533519ebc0cb
children ae67ea0af696
rev   line source
Chris@486 1
Chris@486 2 EasyMercurial
Chris@486 3 =============
Chris@486 4
Chris@486 5 EasyMercurial is a user interface for the Mercurial distributed
Chris@486 6 version control system.
Chris@486 7
Chris@486 8 EasyMercurial is intended to be:
Chris@486 9
Chris@486 10 * simple to teach and to learn
Chris@486 11 * indicative of repository state using a history graph representation
Chris@486 12 * recognisably close to normal command-line workflow for Mercurial
Chris@486 13 * consistent across platforms
Chris@486 14
Chris@486 15 We are not trying to produce "the best" Mercurial client for any one
Chris@486 16 purpose. We actively encourage users to move on to other clients as
Chris@486 17 their needs evolve. The aim is simply to provide something accessible
Chris@486 18 for beginners in small project groups working with a shared remote
Chris@486 19 repository.
Chris@486 20
Chris@486 21 The application is developed by Chris Cannam for SoundSoftware.ac.uk,
Chris@486 22 based on the HgExplorer application by Jari Korhonen, and is published
Chris@486 23 under the GPL. See the file COPYING for license details.
Chris@486 24
Chris@486 25
Chris@486 26 Building EasyMercurial
Chris@486 27 ======================
Chris@486 28
Chris@486 29 EasyMercurial is written in C++ using the Qt4 toolkit. On most
Chris@486 30 platforms, you can build it by running "qmake" followed by "make". Qt
Chris@486 31 version 4.6 or newer is required.
Chris@486 32
Chris@486 33
Chris@486 34 To run EasyMercurial
Chris@486 35 ====================
Chris@486 36
Chris@486 37 Just run the EasyMercurial application that is produced by the build.
Chris@486 38 You will of course also need to have Mercurial installed (version 1.7
Chris@486 39 or newer). If you want to use the EasyHg authentication extension,
Chris@486 40 you will also need PyQt4 (the Python bindings for Qt4); you may also
Chris@486 41 wish to install the python-crypto library for the password store.
Chris@486 42 Finally, an external diff/merge utility is required, typically kdiff3.
Chris@486 43
Chris@486 44
Chris@486 45 EasyMercurial is
Chris@486 46 Copyright 2010 Jari Korhonen
Chris@560 47 Copyright 2010-2012 Chris Cannam
Chris@560 48 Copyright 2010-2012 Queen Mary, University of London
Chris@486 49
Chris@486 50
Chris@486 51
Chris@486 52