Steps regarding a sane source documentation.
[opensuse:build-service.git] / INSTALL
1 ============================
2 Installation and development
3 ============================
4
5 This document explains how to setup the Build Service for development or
6 deployment.
7
8
9 Prerequisites
10 =============
11
12 Before you can start developing for the openSUSE Build Service or deploying
13 it, you have to fetch some additional dependencies in the repository. Please
14 issue the following commands in your shell/terminal:
15
16  $ git submodule init
17  $ git submodule update
18  $ git pull origin master
19
20 For simplicity, you can also use the script 'git-update', that is supplied
21 in the 'dist' folder.
22
23
24 Software dependencies
25 =====================
26
27 For the backend:
28
29 - MySQL version FOO
30 - Perl version FOO
31
32 For the api and webui:
33
34 - Ruby version FOO
35 - Sqlite3 version FOO
36 - Ruby on Rails version 2.3.8
37
38
39 Deployment
40 ==========
41
42 TODO
43
44 Option 1: Only use the webui
45 ----------------------------
46
47 TODO
48
49
50 Option 2: Use the webui and api
51 -------------------------------
52
53 TODO
54
55
56 Option 2: Setup a complete Build Service
57 ----------------------------------------
58
59 TODO
60
61
62 Development
63 ===========
64
65