Download as
Browse Code »

Commit 3d662e5ccfc5555e27773e7a7463ddffc1b678da

Authored by Danilo Cabello
1 parent 9dc46eee
Exists in master and in 4 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb, spb-stable

Refactor README to split production/development environments

Showing 1 changed file with 18 additions and 11 deletions   Show diff stats
README.md
  Diff comments   View file @3d662e5
... ... @@ -5,14 +5,14 @@
5 5 ### GitLab allows you to
6 6 * keep your code secure on your own server
7 7 * manage repositories, users and access permissions
8   - * communicate though issues, line-comments and wiki's
9   - * perform code reviews with merge requests
  8 + * communicate through issues, line-comments and wiki pages
  9 + * perform code review with merge requests
10 10  
11 11 ### GitLab is
12 12  
13 13 * powered by Ruby on Rails
14 14 * completely free and open source (MIT license)
15   -* used by 10.000 organization to keep their code secure
  15 +* used by 10.000 organizations to keep their code secure
16 16  
17 17 ### Code status
18 18  
... ... @@ -34,28 +34,35 @@
34 34  
35 35 ### Requirements
36 36  
37   -* Ubuntu/Debian*
  37 +* Ubuntu/Debian**
38 38 * ruby 1.9.3+
39 39 * MySQL
40 40 * git
41 41 * gitlab-shell
42 42 * redis
43 43  
44   -* 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 45  
46 46 ### Installation
47 47  
48   -You can either follow the "ordinary" Installation guide to install it on a machine or use the Vagrant virtual machine. The Installation guide is recommended to set up a production server. The Vagrant virtual machine is recommended for development since it makes it much easier to set up all the dependencies for integration testing.
  48 +#### For production
49 49  
50   -* [Installation guide for latest stable release (4.2)](https://github.com/gitlabhq/gitlabhq/blob/4-2-stable/doc/install/installation.md)
  50 +Follow the installation guide for production server.
  51 +
  52 +* [Installation guide for latest stable release (4.2)](https://github.com/gitlabhq/gitlabhq/blob/4-2-stable/doc/install/installation.md) - **Recommended**
51 53  
52 54 * [Installation guide for the current master branch (5.0)](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md)
53 55  
  56 +
  57 +#### For development
  58 +
  59 +If you want to contribute, please first read our [Contributing Guidelines](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) and then we suggest you to use the Vagrant virtual machine project to get an environment working sandboxed and with all dependencies.
  60 +
54 61 * [Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm)
55 62  
56 63 ### Starting
57 64  
58   -1. The Installation guide contains instructions to download an init script and run that on boot. With the init script you can also start GitLab with:
  65 +1. The Installation guide contains instructions to download an init script and run that on boot. With the init script you can also start GitLab
59 66  
60 67 sudo service gitlab start
61 68  
... ... @@ -63,18 +70,18 @@ You can either follow the "ordinary" Installation guide to install it on a machi
63 70  
64 71 sudo /etc/init.d/gitlab restart
65 72  
66   -2. Start it with [Foreman](https://github.com/ddollar/foreman) in development model
  73 +2. Start it with [Foreman](https://github.com/ddollar/foreman) in development mode
67 74  
68 75 bundle exec foreman start -p 3000
69 76  
70   -3. Start it manually in development mode
  77 + or start it manually
71 78  
72 79 bundle exec rails s
73 80 bundle exec rake sidekiq:start
74 81  
75 82 ### Running the tests
76 83  
77   -* Seed the database with
  84 +* Seed the database
78 85  
79 86 bundle exec rake db:setup RAILS_ENV=test
80 87 bundle exec rake db:seed_fu RAILS_ENV=test
... ...