README

   1 aurweb
   2 ======
   3
   4 aurweb is a framework for hosting the Arch User Repository (AUR), a collection
   5 of packaging scripts that are created and submitted by the Arch Linux
   6 community. The scripts contained in the repository (PKGBUILDs) can be built
   7 using makepkg and installed via the Arch Linux package manager pacman. The
   8 aurweb project aims to provide the necessary web interface, database schema,
   9 and scripts for a multi-lingual community-driven repository.
  10
  11 Functionality
  12 -------------
  13
  14 * Users may submit source packages that contain a PKGBUILD.
  15 * User accounts with varying permission levels (User, Trusted User, Developer).
  16 * Ability to search for specific submitted packages.
  17 * Display package information by parsing meta-data provided with the packages.
  18 * Users can make comments on package information page.
  19 * Mark packages as out-of-date.
  20 * Vote for well-done and popular user submitted packages.
  21 * Trusted User and Developer can search for and modify accounts.
  22 * Area for Trusted Users to post AUR-related proposals and vote on them.
  23
  24 Directory Layout
  25 ----------------
  26
  27 doc::
  28         aurweb documentation.
  29
  30 po::
  31         Translation files for strings in the aurweb interface.
  32
  33 scripts::
  34         aurblup package blacklist tool. Scripts for AUR maintenance.
  35
  36 support::
  37         Schema for SQL database. Script for dummy data generation.
  38
  39 web::
  40         Web interface for the AUR.
  41
  42 Links
  43 -----
  44
  45 * The repository is hosted at git://projects.archlinux.org/aurweb.git -- see
  46   doc/CodingGuidelines for information on submitting patches.
  47
  48 * Discovered bugs can be submitted to the aurweb bug tracker:
  49   https://bugs.archlinux.org/index.php?project=2
  50
  51 * Questions, comments, and patches related to aurweb can be sent to the AUR
  52   development mailing list: aur-dev@archlinux.org -- mailing list archives:
  53   https://mailman.archlinux.org/mailman/listinfo/aur-dev