README

   1 aurweb
   2 ======
   3
   4 aurweb is a hosting platform for 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 can be built using `makepkg`
   7 and installed using the Arch Linux package manager `pacman`.
   8
   9 The aurweb project includes
  10
  11 * A web interface to search for packaging scripts and display package details.
  12 * A SSH/Git interface to submit and update packages and package meta data.
  13 * Community features such as comments, votes, package flagging and requests.
  14 * Editing/deletion of packages and accounts by Trusted Users and Developers.
  15 * Area for Trusted Users to post AUR-related proposals and vote on them.
  16
  17 Directory Layout
  18 ----------------
  19
  20 aurweb::
  21         aurweb Python modules.
  22
  23 conf::
  24         Configuration and configuration templates.
  25
  26 doc::
  27         Project documentation.
  28
  29 po::
  30         Translation files for strings in the aurweb interface.
  31
  32 schema::
  33         Schema for the SQL database. Script for dummy data generation.
  34
  35 scripts::
  36         Scripts for AUR maintenance.
  37
  38 test::
  39         Test suite and test cases.
  40
  41 upgrading::
  42         Instructions for upgrading setups from one release to another.
  43
  44 web::
  45         Web interface for the AUR.
  46
  47 Links
  48 -----
  49
  50 * The repository is hosted at git://git.archlinux.org/aurweb.git -- see
  51   doc/CodingGuidelines for information on the patch submission process.
  52
  53 * Bugs can (and should) be submitted to the aurweb bug tracker:
  54   https://bugs.archlinux.org/index.php?project=2
  55
  56 * Questions, comments, and patches related to aurweb can be sent to the AUR
  57   development mailing list: aur-dev@archlinux.org -- mailing list archives:
  58   https://mailman.archlinux.org/mailman/listinfo/aur-dev