Download as
Browse Code »

Commit 737a449795c9057fab1f326f28c8e24972d0bd71

Authored by Sytse Sijbrandij
1 parent 1cfc2b6f
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Cleaned up and enhanced readme. 

Finishing touches.

Make the layout more consistent.
Showing 1 changed file with 57 additions and 25 deletions   Show diff stats
README.md
  Diff comments   View file @737a449
1   -## GitLab is a self hosted Git management software.
2   -
3   -Check out [gitlab.org](http://gitlab.org)
  1 +## GitLab: self hosted Git management software
4 2  
5 3 ![logo](https://raw.github.com/gitlabhq/gitlabhq/master/public/gitlab_logo.png)
6 4  
7   -With GitLab you can:
8   - * create projects and repositories
9   - * manage repositories access
10   - * do code review
  5 +### GitLab allows you to
  6 + * keep your code secure on your own server
  7 + * manage repositories, users and access permissions
  8 + * communicate though issues, line-comments and wiki's
  9 + * perform code reviews with merge requests
  10 +
  11 +### GitLab is
11 12  
12   -- - -
  13 +* powered by Ruby on Rails
  14 +* completely free and open source (MIT license)
  15 +* used by 10.000 organization to keep their code secure
13 16  
14   -### Code status:
  17 +### Code status
15 18  
16   -* master: travis-ci.org
17   - [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq)
  19 +* [![build status](http://ci.gitlab.org/projects/1/status?ref=master)](http://ci.gitlab.org/projects/1?ref=master) ci.gitlab.org (master branch)
18 20  
19   -* master: ci.gitlab.org
20   - [![CI](http://ci.gitlab.org/projects/1/status?ref=master)](http://ci.gitlab.org/projects/1?ref=master)
  21 +* [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq) travis-ci.org (master branch)
21 22  
22 23 * [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq)
  24 +
23 25 * [![Dependency Status](https://gemnasium.com/gitlabhq/gitlabhq.png)](https://gemnasium.com/gitlabhq/gitlabhq)
24 26  
25   -### Application details
  27 +### Resources
26 28  
27   -* powered by Ruby on Rails
28   -* its completely free and open source
29   -* distributed under the MIT License
  29 +* 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)
  30 +
  31 +* 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/)
  32 +
  33 +* GitLab CI: [Readme](https://github.com/gitlabhq/gitlab-ci/blob/master/README.md) of the GitLab open-source continuous integration server
30 34  
31 35 ### Requirements
32 36  
33   -* Ubuntu/Debian
  37 +* Ubuntu/Debian*
34 38 * ruby 1.9.3+
35 39 * MySQL
36 40 * git
37 41 * gitlab-shell
38 42 * redis
39 43  
40   -More details are in the [requirements doc](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md)
  44 +* More details are in the [requirements doc](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md)
  45 +
  46 +### Getting started
  47 +
  48 +* [Installation guide for latest stable release](https://github.com/gitlabhq/gitlabhq/blob/4-2-stable/doc/install/installation.md)
  49 +
  50 +* [Installation guide for the current master branch](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md)
  51 +
  52 +* [Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm)
  53 +
  54 +* [Developer guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide)
  55 +
  56 +* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/wiki)
  57 +
  58 +* [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md)
  59 +
  60 +* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
  61 +
  62 +### Getting help
  63 +
  64 +* [Troubleshooting guide](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide)
  65 +
  66 +* [Support forum](https://groups.google.com/forum/#!forum/gitlabhq)
  67 +
  68 +* [Feedback and suggestions forum](http://gitlab.uservoice.com/forums/176466-general)
  69 +
  70 +* [Paid support](http://blog.gitlab.com/support/)
  71 +
  72 +* [Paid services](http://blog.gitlab.com/services/)
41 73  
42   -### Install
  74 +### Getting in touch
43 75  
44   -Checkout [wiki](https://github.com/gitlabhq/gitlabhq/wiki) pages for installation information, migration, etc.
  76 +* [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)
45 77  
46   -### [Community](http://gitlab.org/community/)
  78 +* [Core team](https://github.com/gitlabhq?tab=members)
47 79  
48   -### [Contact](http://gitlab.org/contact/)
  80 +* [Contributors](https://github.com/gitlabhq/gitlabhq/graphs/contributors)
49 81  
50   -### [Contributing Guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)
  82 +* [Leader](https://github.com/randx)
51 83  
52   -### [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide)
  84 +* [Contact page](http://gitlab.org/contact/)
... ...