OSDN Git Service

Cleaned up and enhanced readme.
authorSytse Sijbrandij <sytse@dosire.com>
Sat, 2 Mar 2013 11:53:27 +0000 (12:53 +0100)
committerSytse Sijbrandij <sytse@dosire.com>
Sat, 2 Mar 2013 12:04:57 +0000 (13:04 +0100)
Finishing touches.

Make the layout more consistent.

README.md

index 267f423..4a5ea2d 100644 (file)
--- 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
+
+### GitLab is
 
-- - -
+* powered by Ruby on Rails
+* completely free and open source (MIT license)
+* used by 10.000 organization to keep their code secure
 
-### Code status:
+### Code status
 
-* master: travis-ci.org
-  [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq)
+* [![build status](http://ci.gitlab.org/projects/1/status?ref=master)](http://ci.gitlab.org/projects/1?ref=master) ci.gitlab.org (master branch)
 
-* master: ci.gitlab.org
-  [![CI](http://ci.gitlab.org/projects/1/status?ref=master)](http://ci.gitlab.org/projects/1?ref=master)
+* [![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)
 
-### Application details
+### Resources
 
-* powered by Ruby on Rails
-* its completely free and open source
-* distributed under the MIT License
+* 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)
+
+### Getting started
+
+* [Installation guide for latest stable release](https://github.com/gitlabhq/gitlabhq/blob/4-2-stable/doc/install/installation.md)
+
+* [Installation guide for the current master branch](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md)
+
+* [Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm)
+
+* [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/)
 
-### Install
+### Getting in touch
 
-Checkout [wiki](https://github.com/gitlabhq/gitlabhq/wiki) pages for installation information, migration, etc.
+* [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)
 
-### [Community](http://gitlab.org/community/)
+* [Core team](https://github.com/gitlabhq?tab=members)
 
-### [Contact](http://gitlab.org/contact/)
+* [Contributors](https://github.com/gitlabhq/gitlabhq/graphs/contributors)
 
-### [Contributing Guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)
+* [Leader](https://github.com/randx)
 
-### [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide)
+* [Contact page](http://gitlab.org/contact/)