README

   1 .. |(version)| replace:: 0.3
   2
   3 =======
   4 geanyvc
   5 =======
   6
   7 .. contents::
   8
   9 About
  10 =====
  11
  12 geanyvc is plugin that provides a uniform way of accessing the different
  13 version-control systems inside Geany IDE. Only small subset of vc is
  14 implemented, but, hey, you don't need anything besides diff, log, status,
  15 revert and commit most time.
  16
  17 Features
  18 ========
  19
  20 geanyvc currently support the following version control systems:
  21
  22 Bazaar, GIT, Mercurial, Subversion, SVK::
  23
  24  * diff file
  25  * diff directory
  26  * diff project
  27  * blame
  28  * log file
  29  * log directory
  30  * log project
  31  * status
  32  * revert file
  33  * add file
  34  * remove file
  35  * commit
  36  * blame
  37
  38 CVS::
  39
  40  * diff file
  41  * diff directory
  42  * diff project
  43  * log file
  44  * log directory
  45  * log project
  46  * status
  47  * revert file
  48
  49 Requirements
  50 ============
  51
  52 For compiling geanyvc you need Geany sources, you can get them at
  53 http://geany.uvena.de/, you will need the GTK (>= 2.6.0) libraries
  54 and header files. You will also need its dependency libraries and header
  55 files, such as Pango, Glib and ATK. All these files are available at
  56 http://www.gtk.org. If you like to use spellchecking for your commit
  57 messages you will also need gtkspell (>=2.0), but this is only optional.
  58
  59 Furthermore you need, of course, a C compiler and the Make tool; The
  60 GNU versions of these tools are recommended.
  61
  62 Usage
  63 =====
  64
  65 After compiling and/or installing geanyvc, start Geany and go to menu
  66 Tools->Plugin Manager and set checkbox at VC plugin.
  67
  68 You can configure the following options:
  69
  70 * Set Change flag for document tabs created with pluging.
  71
  72 If this option is activated, every new by the VC-plugin created document tab
  73 will be marked as changed. Even thus this option is useful in some cases, it
  74 could cause a big number of sometimes annoying "Do you want to save"-dialogs.
  75
  76 * Confirm adding new files to a VCS
  77
  78 Shows a confirmation dialog on adding a new (created) file to VCS. If not set
  79 you will not see dialog "Do you want to add <file>?"
  80
  81 * Enable CVS/GIT/Mercurial/SVN/SVK/Bazaar
  82
  83 geanyvc detect if opened file is in version control by checking directories
  84 and executing commands from version control systems toolchain. These options
  85 disable checking for particular version control system. Disabling not
  86 required ones can speed up things. So it is recommended to activate svk only
  87 if you want to use it, since it is quiet slowly.
  88
  89 License
  90 =======
  91
  92 geanyvc is distributed under the terms of the GNU General Public License
  93 as published by the Free Software Foundation; either version 2 of the
  94 License, or (at your option) any later version. A copy of this license
  95 can be found in the file COPYING included with the source code of this
  96 program.
  97
  98 Ideas, questions, patches and bug reports
  99 =========================================
 100
 101 If you add something, or fix a bug, please send a patch (in 'diff -u'
 102 format) to the geany mailing list or to one of the authors listed bellow.
 103
 104 Coding
 105 ======
 106
 107 Use static functions where possible.
 108 Try to use GLib types and functions - e.g. g_free instead of free and
 109 try to use only GLib 2.6 and GTK 2.6 functions. At least for the moment,
 110 we want to keep the minimum requirement for GTK at 2.6.
 111
 112 Style
 113 =====
 114
 115 The file indent-all.sh contains information about
 116 the current code style. Run this script before commit.
 117
 118 Download
 119 ========
 120
 121 The current version is |(version)|, download it here http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.3.tar.gz.
 122
 123 There is also git repository http://git.or.cz available. In http://repo.or.cz/w/geanyvc.git you can
 124 always find an up-to-date version of source code, even between releases.
 125
 126 To clone geanyvc make sure you have the git package installed on your system.
 127 Then run the following command::
 128
 129  git clone git://repo.or.cz/geanyvc.git
 130
 131 or::
 132
 133  git clone http://repo.or.cz/r/geanyvc.git
 134
 135 Gentoo
 136 ------
 137
 138 Gentoo ebuild is available here: http://bugs.gentoo.org/show_bug.cgi?id=218522
 139
 140 Arch linux
 141 ----------
 142
 143 A package for Arch Linux is available here: http://aur.archlinux.org/packages.php?ID=16484
 144
 145 Source Mage
 146 -----------
 147
 148 To install geanyvc, just run the following command::
 149
 150   cast geanyvc
 151
 152 Windows
 153 -------
 154
 155 A windows installer is available here: http://users.cosmostv.by/yurand/geanyvc/geanyvc-0.3_setup.exe
 156
 157 --
 158 2007-2008 by Yura Siamashka and Frank Lanitz
 159 yurand2(at)gmail(dot)com
 160 frank(at)frank(dot)uvena(dot)de