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 Installation
  36 ============
  37
  38 Please refer to the INSTALL file.
  39
  40
  41 License
  42 =======
  43
  44 The OBS source code is released under the terms of the GPL, except where noted.
  45 Additionally, 3rd-party content (like, but not exclusively, the webui icon
  46 theme) may be released under a different license. Please check the respective
  47 files for details.
  48
  49
  50 Miscelaneous
  51 ============
  52
  53 Further documentation for the Build Service can be found at the openSUSE wiki
  54 on the Build Service portal page:
  55
  56  http://en.opensuse.org/Portal:Build_Service
  57
  58 The running Build Service web interface can be accessed here:
  59
  60  http://build.opensuse.org/
  61
  62
  63     Your openSUSE Build Service Team