diff options
author | Ciro Santilli <ciro.santilli@gmail.com> | 2014-04-25 00:48:22 +0200 |
---|---|---|
committer | Ciro Santilli <ciro.santilli@gmail.com> | 2014-06-03 23:16:31 +0200 |
commit | fd348de76d651d49acc8eb742cc647dc777ef5fc (patch) | |
tree | 26f42bef57c9a636eff0a548a29cb1e2e6d12c8c /README.md | |
parent | de1a7aa7eb523cf2fdad12f8eeda2ba4c5b51820 (diff) | |
download | gitlab-ce-fd348de76d651d49acc8eb742cc647dc777ef5fc.tar.gz |
Update docs to markdown style guide.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 90 |
1 files changed, 45 insertions, 45 deletions
diff --git a/README.md b/README.md index 9cdb6bf3a6d..166e1187bfd 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,55 @@ -## GitLab: self hosted Git management software +# GitLab + +## Self hosted Git management software ![logo](https://gitlab.com/gitlab-org/gitlab-ce/raw/master/public/gitlab_logo.png) ![animated-screenshots](https://gist.github.com/fnkr/2f9badd56bfe0ed04ee7/raw/4f48806fbae97f556c2f78d8c2d299c04500cb0d/compiled.gif) -### Gitlab is open source software to collaborate on code +## Open source software to collaborate on code -* Manage git repositories with fine grained access controls that keep your code secure -* Perform code reviews and enhance collaboration with merge requests -* Each project can also have an issue tracker and a wiki -* Used by more than 100,000 organizations, GitLab is the most popular solution to manage git repositories on-premises -* Completely free and open source (MIT Expat license) -* Powered by Ruby on Rails +- Manage Git repositories with fine grained access controls that keep your code secure +- Perform code reviews and enhance collaboration with merge requests +- Each project can also have an issue tracker and a wiki +- Used by more than 100,000 organizations, GitLab is the most popular solution to manage Git repositories on-premises +- Completely free and open source (MIT Expat license) +- Powered by Ruby on Rails -### Canonical source +## Canonical source -* The source of GitLab Community Edition is [hosted on GitLab.com](https://gitlab.com/gitlab-org/gitlab-ce/) and there are mirrors to make [contributing](CONTRIBUTING.md) as easy as possible. +- The source of GitLab Community Edition is [hosted on GitLab.com](https://gitlab.com/gitlab-org/gitlab-ce/) and there are mirrors to make [contributing](CONTRIBUTING.md) as easy as possible. -### Code status +## Code status -* [![build status](https://ci.gitlab.org/projects/1/status.png?ref=master)](https://ci.gitlab.org/projects/1?ref=master) on ci.gitlab.org (master branch) +- [![build status](https://ci.gitlab.org/projects/1/status.png?ref=master)](https://ci.gitlab.org/projects/1?ref=master) on ci.gitlab.org (master branch) -* [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq) +- [![Code Climate](https://codeclimate.com/github/gitlabhq/gitlabhq.png)](https://codeclimate.com/github/gitlabhq/gitlabhq) -* [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq) +- [![Coverage Status](https://coveralls.io/repos/gitlabhq/gitlabhq/badge.png?branch=master)](https://coveralls.io/r/gitlabhq/gitlabhq) -* [![PullReview stats](https://www.pullreview.com/gitlab/gitlab-org/gitlab-ce/badges/master.svg?)](https://www.pullreview.com/gitlab.gitlab.com/gitlab-org/gitlab-ce/reviews/master) +- [![PullReview stats](https://www.pullreview.com/gitlab/gitlab-org/gitlab-ce/badges/master.svg?)](https://www.pullreview.com/gitlab.gitlab.com/gitlab-org/gitlab-ce/reviews/master) ### Resources -* [www.gitlab.com](https://www.gitlab.com/) includes information about [subscriptions](https://www.gitlab.com/subscription/), [consultancy](https://www.gitlab.com/consultancy/), the [community](https://www.gitlab.com/community/) and the [hosted GitLab.com](https://www.gitlab.com/gitlab-com/). +- [www.gitlab.com](https://www.gitlab.com/) includes information about [subscriptions](https://www.gitlab.com/subscription/), [consultancy](https://www.gitlab.com/consultancy/), the [community](https://www.gitlab.com/community/) and the [hosted GitLab.com](https://www.gitlab.com/gitlab-com/). -* [GitLab Enterprise Edition](https://www.gitlab.com/gitlab-ee/) offers additional features aimed at larger organizations. +- [GitLab Enterprise Edition](https://www.gitlab.com/gitlab-ee/) offers additional features aimed at larger organizations. -* [GitLab CI](https://www.gitlab.com/gitlab-ci/) is a continuous integration (CI) server that is easy to integrate with GitLab. +- [GitLab CI](https://www.gitlab.com/gitlab-ci/) is a continuous integration (CI) server that is easy to integrate with GitLab. -* Unofficial third-party [iPhone app](http://gitlabcontrol.com/), [Android app](https://play.google.com/store/apps/details?id=com.bd.gitlab&hl=en), [command line client](https://github.com/drewblessing/gitlab-cli), [Ruby API wrapper](https://github.com/NARKOZ/gitlab) and [Chrome app](https://chrome.google.com/webstore/detail/chrome-gitlab-notifier/eageapgbnjicdjjihgclpclilenjbobi) for GitLab. +- Unofficial third-party [iPhone app](http://gitlabcontrol.com/), [Android app](https://play.google.com/store/apps/details?id=com.bd.gitlab&hl=en), [command line client](https://github.com/drewblessing/gitlab-cli), [Ruby API wrapper](https://github.com/NARKOZ/gitlab) and [Chrome app](https://chrome.google.com/webstore/detail/chrome-gitlab-notifier/eageapgbnjicdjjihgclpclilenjbobi) for GitLab. -### Requirements +## Requirements -* Ubuntu/Debian/CentOS/RHEL** -* ruby 2.0+ -* git 1.7.10+ -* redis 2.0+ -* MySQL or PostgreSQL +- Ubuntu/Debian/CentOS/RHEL** +- ruby 2.0+ +- git 1.7.10+ +- redis 2.0+ +- MySQL or PostgreSQL -** More details are in the [requirements doc](doc/install/requirements.md) +** More details are in the [requirements doc](doc/install/requirements.md). -### Installation +## Installation Please see [the installation page on the GitLab website](https://www.gitlab.com/installation/). @@ -59,22 +61,21 @@ Since 2011 a minor or major version of GitLab is released on the 22nd of every m For updating the the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For manual installations there is an [upgrader script](doc/update/upgrader.md) and there are [upgrade guides](doc/update). -### Run in production mode +## Run in production mode The Installation guide contains instructions on how to download an init script and run it automatically on boot. You can also start the init script manually: sudo service gitlab start -or by directly calling the script +or by directly calling the script: sudo /etc/init.d/gitlab start -Please login with root / 5iveL!fe +Please login with `root` / `5iveL!fe`. ### Install a development environment -We recommend setting up your development environment with [the cookbook](https://gitlab.com/gitlab-org/cookbook-gitlab/blob/master/README.md#installation). -If you do not use the cookbook you might need to copy the example development unicorn configuration file +We recommend setting up your development environment with [the cookbook](https://gitlab.com/gitlab-org/cookbook-gitlab/blob/master/README.md#installation). If you do not use the cookbook you might need to copy the example development unicorn configuration file cp config/unicorn.rb.example.development config/unicorn.rb @@ -84,36 +85,35 @@ Start it with [Foreman](https://github.com/ddollar/foreman) bundle exec foreman start -p 3000 -or start each component separately +or start each component separately: bundle exec rails s bin/background_jobs start -And surf to [localhost:3000](http://localhost:3000/) and login with root / 5iveL!fe +And surf to [localhost:3000](http://localhost:3000/) and login with `root` / `5iveL!fe`. -### Run the tests +## Run the tests -* Run all tests +- Run all tests: bundle exec rake test -* [RSpec](http://rspec.info/) unit and functional tests - - All RSpec tests: bundle exec rake spec +- [RSpec](http://rspec.info/) unit and functional tests. - Single RSpec file: bundle exec rspec spec/controllers/commit_controller_spec.rb + All RSpec tests: `bundle exec rake spec` -* [Spinach](https://github.com/codegram/spinach) integration tests + Single RSpec file: `bundle exec rspec spec/controllers/commit_controller_spec.rb` - All Spinach tests: bundle exec rake spinach +- [Spinach](https://github.com/codegram/spinach) integration tests. - Single Spinach test: bundle exec spinach features/project/issues/milestones.feature + All Spinach tests: `bundle exec rake spinach` + Single Spinach test: `bundle exec spinach features/project/issues/milestones.feature` -### Documentation +## Documentation All documentation can be found on [doc.gitlab.com/ce/](http://doc.gitlab.com/ce/). -### Getting help +## Getting help Please see [Getting help for GitLab](https://www.gitlab.com/getting-help/) on our website for the many options to get help. |