README

   1 ===================
   2 Arch User Repository (AUR)
   3 ===================
   4
   5 About:
   6 =====
   7 The Arch User Repository (AUR) is a framework for hosting a collection of
   8 packaging scripts that are created and submitted by the Arch community. The
   9 scripts contained in the repository (PKGBUILDS) can be built using the Arch
  10 building/packaging script (makepkg) and installed via the Arch pacman manager
  11 (pacman). The AUR project aims to provide the necessary web interface, database
  12 schema, and scripts for a multi-lingual community-driven repository.
  13
  14 Functionality:
  15 =========
  16 -Users may submit source packages that contain a PKGBUILD
  17 -User accounts with varying permission levels (User, Trusted User, Developer)
  18 -Ability to search for specific submitted packages (based on package name,
  19 package description, package submitter, package maintainer)
  20 -Display submitted package information by parsing PKGBUILD (description,
  21 license, package dependencies, etc)
  22 -Users can make comments on package information page
  23 -Mark packages as out-of-date
  24 -Vote for well-done and popular user submitted packages
  25 -Trusted User and Developer have ability to search for and modify accounts
  26 -Area for Trusted Users
  27 and Developers to post AUR-related proposals and vote on them
  28
  29 File Hierarchy:
  30 ==========
  31
  32 Directory Layout:
  33 -------------------
  34 ./po            - Translation files for strings in the AUR web
  35                 interface.
  36 ./scripts       - aurblup package blacklist tool. Scripts for AUR
  37                 maintenance.
  38 ./support       - Schema for SQL database. Script for dummy data generation.
  39 ./web           - Web interface for the AUR.
  40
  41 Files:
  42 ------
  43 AUTHORS         - List of maintainers, contributors, and translators for AUR
  44                 project.
  45 COPYING         - License information for AUR project (GPL version 2).
  46 HACKING         - Guidelines for modifying source and submitting
  47                 patches.
  48 INSTALL         - Installation procedure for AUR.
  49 TODO            - List of potential features and changes to be made to the AUR.
  50 TRANSLATING     - Directions for creating and updating string translations.
  51 UPGRADING       - Changes needed to upgrade older AUR version to newer version.
  52
  53 Code:
  54 =====
  55 Official repository hosted at git://projects.archlinux.org/aur.git
  56 See HACKING for information on submitting patches
  57
  58 Bugs:
  59 =====
  60 Discovered bugs can be submitted to the AUR bug tracker:
  61 https://bugs.archlinux.org/index.php?project=2
  62
  63 Contact:
  64 ========
  65 Questions, comments, and patches related to the AUR can be sent to the AUR
  66 development mailing list: aur-dev@archlinux.org
  67 Mailing list archives: https://mailman.archlinux.org/mailman/listinfo/aur-dev