README

   1 GitX
   2 ---------------
   3
   4 # What is GitX?
   5
   6 GitX is a gitk like clone written specifically for OS X Leopard and higher.
   7 This means that it has a native interface and tries to integrate with the
   8 operating system as good as possible. Examples of this are drag and drop
   9 support and QuickLook support.
  10
  11
  12 # Features
  13
  14 The project is currently still in its starting phases. As time goes on,
  15 hopefully more features will be added. Currently GitX supports the following:
  16
  17   * History browsing of your repository
  18   * See a nicely formatted diff of any revision
  19   * Search based on author or revision subject
  20   * Look at the complete tree of any revision
  21     * Preview any file in the tree in a text view or with QuickLook
  22     * Drag and drop files out of the tree view to copy them to your system
  23    * Support for all parameters git rev-list has
  24 # License
  25
  26 GitX is licensed under the GPL version 2. For more information, see the attached COPYING file.
  27
  28 # Downloading
  29
  30 GitX is currently hosted at GitHub. It's project page can be found at
  31 http://github.com/pieter/gitx. Recent binary releases can be found at
  32 http://github.com/pieter/gitx/wikis.
  33
  34 If you wish to follow GitX development, you can download the source code
  35 through git:
  36
  37   git clone git://github.com/pieter/gitx
  38
  39 # Installation
  40
  41 The easiest way to get GitX running is to download the binary release from the
  42 wiki. If you wish to compile it yourself, you will need XCode 3.0 or later. As
  43 GitX makes use of features available only on Leopard (such as garbage
  44 collection), you will not be able to compile it on previous versions of OS X.
  45
  46 To compile GitX, open the GitX.xcodeproj file and hit "Build".
  47
  48 # Usage
  49
  50 GitX itself is fairly simple. Most of its power is in the 'gitx' binary, which
  51 you should install through the menu. the 'gitx' binary supports most of git
  52 rev-list's arguments. For example, you can run `gitx --all' to display all
  53 branches in the repository, or `gitx -- Documentation' to only show commits
  54 relating to the 'Documentation' subdirectory. With `gitx -Shaha', gitx will
  55 only show commits that contain the word 'haha'. Similarly, with 'gitx
  56 v0.2.1..', you will get a list of all commits since version 0.2.1.
  57
  58 # Helping out
  59
  60 Any help on GitX is welcome. GitX is programmed in Objective-C, but even if
  61 you are not a programmer you can do useful things. A short selection:
  62
  63   * Create a nice icon;
  64   * Help with the Javascript/HTML views, such as the diff view;
  65   * File bug reports and feature requests.
  66
  67 A TODO list can be found on the wiki: http://github.com/pieter/gitx/wikis/todo
  68