Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent 4f9ebda commit 58914c8304ef25ba956f78bcf04492c66a2a91b9 @klaussilveira committed Oct 23, 2013
Showing with 15 additions and 13 deletions.
  1. +15 −13 README.md
View
@@ -1,4 +1,4 @@
-# GitList: an elegant and modern git repository viewer
+# GitList: an elegant git repository viewer
[![Build Status](https://secure.travis-ci.org/klaussilveira/gitlist.png)](http://travis-ci.org/klaussilveira/gitlist)
GitList is an elegant and modern web interface for interacting with multiple git repositories. It allows you to browse repositories using your favorite browser, viewing files under different revisions, commit history, diffs. It also generates RSS feeds for each repository, allowing you to stay up-to-date with the latest changes anytime, anywhere. GitList was written in PHP, on top of the [Silex](http://silex.sensiolabs.org/) microframework and powered by the Twig template engine. This means that GitList is easy to install and easy to customize. Also, the GitList gorgeous interface was made possible due to [Bootstrap](http://twitter.github.com/bootstrap/).
@@ -21,18 +21,6 @@ GitList is an elegant and modern web interface for interacting with multiple git
You can also see a live demo [here](http://gitlist-khornberg.rhcloud.com/).
-## Authors and contributors
-* [Klaus Silveira](http://www.klaussilveira.com) (Creator, developer)
-
-## License
-[New BSD license](http://www.opensource.org/licenses/bsd-license.php)
-
-## Todo
-* improve the current test code coverage
-* test the interface
-* submodule support
-* multilanguage support
-
## Requirements
In order to run GitList on your server, you'll need:
@@ -42,6 +30,7 @@ In order to run GitList on your server, you'll need:
## Installation
* Download GitList from [gitlist.org](http://gitlist.org/) and decompress to your `/var/www/gitlist` folder, or anywhere else you want to place GitList.
+* Do not download a branch or tag from GitHub, unless you want to use the development version. The version available for download at the website already has all dependencies bundled, so you don't have to use composer or any other tool
* Rename the `config.ini-example` file to `config.ini`.
* Open up the `config.ini` and configure your installation. You'll have to provide where your repositories are located.
* In case GitList isn't accessed through the root of the website, open .htaccess and edit RewriteBase (for example, /gitlist/ if GitList is accessed through http://localhost/gitlist/).
@@ -55,6 +44,19 @@ chmod 777 cache
That's it, installation complete! If you're having problems, check the [Troubleshooting](https://github.com/klaussilveira/gitlist/wiki/Troubleshooting) page.
+
+## Authors and contributors
+* [Klaus Silveira](http://www.klaussilveira.com) (Creator, developer)
+
+## License
+[New BSD license](http://www.opensource.org/licenses/bsd-license.php)
+
+## Todo
+* improve the current test code coverage
+* test the interface
+* submodule support
+* multilanguage support
+
## Development
GitList uses [Composer](http://getcomposer.org/) to manage dependencies and [Ant](http://ant.apache.org/) to build the project. In order to run all the targets in the build script, you will need [PHPUnit](http://www.phpunit.de/), [phpcpd](https://github.com/sebastianbergmann/phpcpd), [phploc](https://github.com/sebastianbergmann/phploc), [PHPMD](http://phpmd.org/) and [PHP_Depend](http://pdepend.org).

0 comments on commit 58914c8

Please sign in to comment.