Skip to content

Commit 69c0cae

Browse files
committed
Update documentation
1 parent 3d42a4e commit 69c0cae

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

Documentation/ReleaseNotes.txt

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
GitX Release Notes
22

3+
V0.3: Changes since v0.2.1
4+
====
5+
* You can now pass on command-line arguments just like you can with 'git log'
6+
* The program has an icon
7+
* Also displays remote branches in the branch list
8+
* Is better in determining if a directory is a bare git repository
9+
10+
311
V0.2.1
412
===
513
* Added Sparkle update system

README

+11-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ hopefully more features will be added. Currently GitX supports the following:
2020
* Look at the complete tree of any revision
2121
* Preview any file in the tree in a text view or with QuickLook
2222
* Drag and drop files out of the tree view to copy them to your system
23-
23+
* Support for all parameters git rev-list has
2424
# License
2525

2626
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.
4545

4646
To compile GitX, open the GitX.xcodeproj file and hit "Build".
4747

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+
4858
# Helping out
4959

5060
Any help on GitX is welcome. GitX is programmed in Objective-C, but even if

0 commit comments

Comments
 (0)