[api] fix test case for read access protected branches
[opensuse:build-service.git] / README
1 ==================
2 Open Build Service
3 ==================
4
5 The Open Build Service (OBS) is an open and complete distribution
6 development platform designed to encourage developers to compile packages for
7 multiple Linux distributions including openSUSE, Red Hat, Mandriva, Ubuntu,
8 Fedora and Debian. It typically simplifies the packaging process, so developers
9 can more easily package a single program for many distributions, and many
10 openSUSE releases, making more packages available to users regardless of what
11 distribution they use. 
12
13 Further documentation for the Open Build Service can be found at the openSUSE wiki
14 on the Open Build Service portal page:
15
16   http://en.opensuse.org/Portal:Build_Service
17
18 Some running Open Build Service instances are listed here:
19
20   http://www.open-build-service.org/instances.html
21
22
23 Organization
24 ============
25
26 The Open Build Service consists of several parts, namely the backend, the
27 api and the webui. The backend implements all the core functionality (i.e. the
28 business logic), whereas the webui provides a neat browser interface. The api
29 forms the glue between those components and also serves as the integration
30 point to other external tools (hence it's name). Therefore the source code is
31 organized like this:
32
33 ============  ==================================================
34 Directory     Description
35 ============  ==================================================
36 dist          Files relevant for (distro) packaging
37 docs          Documentation, examples and the Build Service book
38 src/api       Api code (Ruby / Ruby on Rails)
39 src/backend   Backend code (Perl)
40 src/webui     Webui code (Ruby / Ruby on Rails)
41 shared        Stuff shared across the different parts
42 ============  ==================================================
43
44 Note that the three parts each also have their own documentation found in their
45 respective subdirectories.
46
47
48 Installation, deployment and development
49 ========================================
50
51 These topics are covered in the file INSTALL and on the openSUSE wiki (see
52 above).
53
54
55 Licensing
56 =========
57
58 The Open Build Service is Free Software and is released under the terms of
59 the GPL, except where noted. Additionally, 3rd-party content (like, but not
60 exclusively, the webui icon theme) may be released under a different license.
61 Please check the respective files for details.
62
63
64 Contact
65 =======
66
67 The Build Service project is hosted on Gitorious and can be found here:
68
69     http://gitorious.org/opensuse/build-service
70
71 You can discuss with the Build Service Team via IRC (FreeNode) on this channel:
72
73     #opensuse-buildservice
74
75 Or you can use the official mailing list:
76
77     opensuse-buildservice@opensuse.org
78
79
80     Your Open Build Service Team