From 49314cd2dcba16ee495cf35ff6d4b1a0b2f05e32 Mon Sep 17 00:00:00 2001 From: Andrew Schleifer Date: Tue, 16 Oct 2012 18:22:47 -0500 Subject: [PATCH] Minor improvements to repository documentation * Change the README to use Markdown syntax. (Which it pretty much did already.) * Add suffixes to README and COPYING. --- COPYING => COPYING.txt | 0 README => README.md | 16 ++++++++-------- 2 files changed, 8 insertions(+), 8 deletions(-) rename COPYING => COPYING.txt (100%) rename README => README.md (95%) diff --git a/COPYING b/COPYING.txt similarity index 100% rename from COPYING rename to COPYING.txt diff --git a/README b/README.md similarity index 95% rename from README rename to README.md index b87b56637..9af1e89f8 100644 --- a/README +++ b/README.md @@ -1,7 +1,7 @@ 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 @@ -9,7 +9,7 @@ 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: @@ -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 @@ -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 @@ -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 @@ -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: