Skip to content

Commit

Permalink
Minor improvements to repository documentation
Browse files Browse the repository at this point in the history
* Change the README to use Markdown syntax. (Which it pretty much did already.)
* Add suffixes to README and COPYING.
  • Loading branch information
andrewschleifer committed Oct 16, 2012
1 parent 267e26f commit 49314cd
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
File renamed without changes.
16 changes: 8 additions & 8 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
GitX
---------------
----

# What is GitX?
## What is GitX?

GitX is a gitk like clone written specifically for OS X Leopard and higher.
This means that it has a native interface and tries to integrate with the
operating system as good as possible. Examples of this are drag and drop
support and QuickLook support.


# Features
## Features

The project is currently still in its starting phases. As time goes on,
hopefully more features will be added. Currently GitX supports the following:
Expand All @@ -21,11 +21,11 @@ hopefully more features will be added. Currently GitX supports the following:
* 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
## License

GitX is licensed under the GPL version 2. For more information, see the attached COPYING file.

# Downloading
## Downloading

GitX is currently hosted at GitHub. It's project page can be found at
http://github.com/pieter/gitx. Recent binary releases can be found at
Expand All @@ -36,7 +36,7 @@ through git:

git clone git://github.com/pieter/gitx

# Installation
## Installation

The easiest way to get GitX running is to download the binary release from the
wiki. If you wish to compile it yourself, you will need XCode 3.0 or later. As
Expand All @@ -45,7 +45,7 @@ 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
## 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
Expand All @@ -55,7 +55,7 @@ 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
## Helping out

Any help on GitX is welcome. GitX is programmed in Objective-C, but even if
you are not a programmer you can do useful things. A short selection:
Expand Down

0 comments on commit 49314cd

Please sign in to comment.