Even better wording and the preparation for project-wide documentation on how to...
[opensuse:build-service.git] / README
1 ======================
2 openSUSE Build Service
3 ======================
4
5 The openSUSE 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
14 Organization
15 ============
16
17 The openSUSE Build Service consists of several parts, namely the backend, the
18 api and the webui. The backend implements all the core functionality (i.e. the
19 business logic), whereas the webui provides a neat browser interface. The api
20 forms the glue between those components and also serves as the integration
21 point to other external tools (hence it's name). Therefore the source code is
22 organized like this:
23
24  dist/          - Helpful scripts and utilities
25  docs/          - Documentation and examples
26  src/api/       - Api code (Ruby / Ruby on Rails)
27  src/backend/   - Backend code (Perl)
28  src/webui/     - Webui code (Ruby / Ruby on Rails)
29  shared/        - Stuff shared across the different parts
30
31 Note that the three parts each also have their own documentation found in their
32 respective subdirectories.
33
34
35 Licensing
36 =========
37
38 The openSUSE Build Service is Free Software and is released under the terms of
39 the GPL, except where noted. Additionally, 3rd-party content (like, but not
40 exclusively, the webui icon theme) may be released under a different license.
41 Please check the respective files for details.
42
43
44 Miscelaneous
45 ============
46
47 Further documentation for the Build Service can be found at the openSUSE wiki
48 on the Build Service portal page:
49
50  http://en.opensuse.org/Portal:Build_Service
51
52 The running Build Service web interface can be accessed here:
53
54  http://build.opensuse.org/
55
56
57     Your openSUSE Build Service Team