About gitpub
--------------------------------------------------------------------------------------

Gitpub aims to be a simple to deploy, PHP based web application for hosting and 
navigating either local or remote git repositories. Gitpub provides a simple
interface which was inspired by the overall look and feel of github.

Features include:
    - Multiple repositories
    - File navigation
    - Branches
    - Commit history
    - Commit file diffs
    - Tag and tag downloads
    - Readonly http cloning
    - RSS feeds
    - Caching


Requirements
--------------------------------------------------------------------------------------

- Apache with PHP support
- Git 1.7.4.x or above
- A directory containing git repositories


Installation
--------------------------------------------------------------------------------------

1) Get the source:

    - clone the repo:

    git clone http://codesmak.com/gitpub/r/gitpub
    cd gitpub

    - download tarball:

    tar xvf gitpub-1.0.0.tar
    cd gitpub-1.0.0/

    - download zip:

    unzip gitpub-1.0.0.zip
    cd gitpub-1.0.0/

2) Configure gitpub:

    cd config
    cp example.gitpub.config.php gitpub.config.php
    vi gitpub.config.php ( set options accordingly )


Notes
--------------------------------------------------------------------------------------

Apache:
    - None.

Git:
    - This has not been tested on versions of Git lower than 1.7.4.1

PHP:
    - If your php installation makes use of open_basedir to restrict access
      to directories. Append the path to both the git bin and the directory 
      where you keep your git repositories. 
    

Contact
--------------------------------------------------------------------------------------
Use gitpub?  Have a question or a comment?  I'd love to hear from you, please direct
all questions or comments to: gitpub@codesmak.com

Enjoy!