From 69c0cae04f270d93c7a18fe7553b096f0bd95f45 Mon Sep 17 00:00:00 2001 From: Pieter de Bie Date: Fri, 12 Sep 2008 19:35:11 +0200 Subject: [PATCH] Update documentation --- Documentation/ReleaseNotes.txt | 8 ++++++++ README | 12 +++++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/Documentation/ReleaseNotes.txt b/Documentation/ReleaseNotes.txt index 0869f27..d86ce0f 100644 --- a/Documentation/ReleaseNotes.txt +++ b/Documentation/ReleaseNotes.txt @@ -1,5 +1,13 @@ GitX Release Notes +V0.3: Changes since v0.2.1 +==== +* You can now pass on command-line arguments just like you can with 'git log' +* The program has an icon +* Also displays remote branches in the branch list +* Is better in determining if a directory is a bare git repository + + V0.2.1 === * Added Sparkle update system diff --git a/README b/README index b770c55..b87b566 100644 --- a/README +++ b/README @@ -20,7 +20,7 @@ hopefully more features will be added. Currently GitX supports the following: * Look at the complete tree of any revision * Preview any file in the tree in a text view or with QuickLook * Drag and drop files out of the tree view to copy them to your system - + * Support for all parameters git rev-list has # License GitX is licensed under the GPL version 2. For more information, see the attached COPYING file. @@ -45,6 +45,16 @@ collection), you will not be able to compile it on previous versions of OS X. To compile GitX, open the GitX.xcodeproj file and hit "Build". +# Usage + +GitX itself is fairly simple. Most of its power is in the 'gitx' binary, which +you should install through the menu. the 'gitx' binary supports most of git +rev-list's arguments. For example, you can run `gitx --all' to display all +branches in the repository, or `gitx -- Documentation' to only show commits +relating to the 'Documentation' subdirectory. With `gitx -Shaha', gitx will +only show commits that contain the word 'haha'. Similarly, with 'gitx +v0.2.1..', you will get a list of all commits since version 0.2.1. + # Helping out Any help on GitX is welcome. GitX is programmed in Objective-C, but even if