From 737a449795c9057fab1f326f28c8e24972d0bd71 Mon Sep 17 00:00:00 2001 From: Sytse Sijbrandij Date: Sat, 2 Mar 2013 12:53:27 +0100 Subject: [PATCH] Cleaned up and enhanced readme. Finishing touches. Make the layout more consistent. --- README.md | 94 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 63 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 267f42360bf..4a5ea2db3d9 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,84 @@ -## GitLab is a self hosted Git management software. - -Check out [gitlab.org](http://gitlab.org) +## GitLab: self hosted Git management software ![logo](https://raw.github.com/gitlabhq/gitlabhq/master/public/gitlab_logo.png) -With GitLab you can: - * create projects and repositories - * manage repositories access - * do code review +### GitLab allows you to + * keep your code secure on your own server + * manage repositories, users and access permissions + * communicate though issues, line-comments and wiki's + * perform code reviews with merge requests -- - - - -### Code status: - -* master: travis-ci.org - [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq) - -* master: ci.gitlab.org - [![CI](http://ci.gitlab.org/projects/1/status?ref=master)](http://ci.gitlab.org/projects/1?ref=master) - -* [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq) -* [![Dependency Status](https://gemnasium.com/gitlabhq/gitlabhq.png)](https://gemnasium.com/gitlabhq/gitlabhq) - -### Application details +### GitLab is * powered by Ruby on Rails -* its completely free and open source -* distributed under the MIT License +* completely free and open source (MIT license) +* used by 10.000 organization to keep their code secure + +### Code status + +* [![build status](http://ci.gitlab.org/projects/1/status?ref=master)](http://ci.gitlab.org/projects/1?ref=master) ci.gitlab.org (master branch) + +* [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq) travis-ci.org (master branch) + +* [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq) + +* [![Dependency Status](https://gemnasium.com/gitlabhq/gitlabhq.png)](https://gemnasium.com/gitlabhq/gitlabhq) + +### Resources + +* GitLab.org community site: [Homepage](http://gitlab.org) [Screenshots](http://gitlab.org/screenshots/) [Blog](http://blog.gitlab.org/) [Demo](http://demo.gitlabhq.com/users/sign_in) + +* GitLab.com: [Homepage](http://blog.gitlab.com/) [Hosted pricing](http://blog.gitlab.com/pricing/) [Services](http://blog.gitlab.com/services/) [Blog](http://blog.gitlab.com/blog/) + +* GitLab CI: [Readme](https://github.com/gitlabhq/gitlab-ci/blob/master/README.md) of the GitLab open-source continuous integration server ### Requirements -* Ubuntu/Debian +* Ubuntu/Debian* * ruby 1.9.3+ * MySQL * git * gitlab-shell * redis -More details are in the [requirements doc](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md) +* More details are in the [requirements doc](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md) -### Install +### Getting started -Checkout [wiki](https://github.com/gitlabhq/gitlabhq/wiki) pages for installation information, migration, etc. +* [Installation guide for latest stable release](https://github.com/gitlabhq/gitlabhq/blob/4-2-stable/doc/install/installation.md) -### [Community](http://gitlab.org/community/) +* [Installation guide for the current master branch](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md) -### [Contact](http://gitlab.org/contact/) +* [Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm) -### [Contributing Guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) +* [Developer guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide) -### [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide) +* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/wiki) + +* [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md) + +* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md) + +### Getting help + +* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) + +* [Support forum](https://groups.google.com/forum/#!forum/gitlabhq) + +* [Feedback and suggestions forum](http://gitlab.uservoice.com/forums/176466-general) + +* [Paid support](http://blog.gitlab.com/support/) + +* [Paid services](http://blog.gitlab.com/services/) + +### Getting in touch + +* [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) + +* [Core team](https://github.com/gitlabhq?tab=members) + +* [Contributors](https://github.com/gitlabhq/gitlabhq/graphs/contributors) + +* [Leader](https://github.com/randx) + +* [Contact page](http://gitlab.org/contact/)