Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSytse Sijbrandij <sytse@dosire.com>2013-03-03 02:27:52 +0400
committerSytse Sijbrandij <sytse@dosire.com>2013-03-03 02:27:52 +0400
commit56d1cc5be50939089c011325b18dee3a295edf4c (patch)
tree6fa7fc1008720a034f2488832e5748ecda7ee753 /README.md
parent5b4032d1759f6ac666fd102a7eed689c8dc110ea (diff)
Replacing the development guide.
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 44 insertions, 5 deletions
diff --git a/README.md b/README.md
index 4a5ea2db3d9..327d495ab7d 100644
--- a/README.md
+++ b/README.md
@@ -43,7 +43,9 @@
* More details are in the [requirements doc](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md)
-### Getting started
+### Installation
+
+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 Vargrant virtual machine is recommended for development since it makes it much easier to set up all the dependencies for integration testing.
* [Installation guide for latest stable release](https://github.com/gitlabhq/gitlabhq/blob/4-2-stable/doc/install/installation.md)
@@ -51,13 +53,40 @@
* [Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm)
-* [Developer guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide)
+### Starting
-* [Upgrade guides](https://github.com/gitlabhq/gitlabhq/wiki)
+1. The Installation guide contains instructions to download an init script and run that on boot. After configuring the init script you can run
-* [Roadmap](https://github.com/gitlabhq/gitlabhq/blob/master/ROADMAP.md)
+sudo service gitlab start
-* [GitLab API](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/README.md)
+or
+
+sudo /etc/init.d/gitlab restart
+
+2. With [foreman](https://github.com/ddollar/foreman)
+
+bundle exec foreman start -p 3000
+
+3. Start it manually
+
+bundle exec rails s
+bundle exec rake environment resque:work QUEUE=* VVERBOSE=1
+
+### Running the tests
+
+* Seed the database with
+
+bundle exec rake db:setup RAILS_ENV=test
+bundle exec rake db:seed_fu RAILS_ENV=test
+
+* Run all tests
+bundle exec rake gitlab:test
+
+* Rspec unit and functional tests
+bundle exec rake spec
+
+* Spinach integration tests
+bundle exec rake spinach
### Getting help
@@ -71,6 +100,16 @@
* [Paid services](http://blog.gitlab.com/services/)
+### New versions and the API
+
+Each month on the 22th a new version is released together with an upgrade 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 in touch
* [Contributing guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)