Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdownified README #107

Open
wants to merge 1 commit into
base: experimental
Choose a base branch
from
Open

Markdownified README #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions README → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
GitX
---------------
# 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 +20,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 +35,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 +44,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 +54,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