Release 3.1.0
[aur.git] / README
blob7688ab54d3adc3f382a4835e4d00bc348d87385d
1 Arch User Repository (AUR)
2 ==========================
4 The Arch User Repository (AUR) is a framework for hosting a collection of
5 packaging scripts that are created and submitted by the Arch community. The
6 scripts contained in the repository (PKGBUILDs) can be built using the AUR
7 building/packaging script `mkaurball` and installed via the Arch package
8 manager `pacman`. The AUR project aims to provide the necessary web interface,
9 database schema, and scripts for a multi-lingual community-driven repository.
11 Functionality
12 -------------
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.
24 Directory Layout
25 ----------------
27 po::
28         Translation files for strings in the AUR web interface.
30 scripts::
31         aurblup package blacklist tool. Scripts for AUR maintenance.
33 support::
34         Schema for SQL database. Script for dummy data generation.
36 web::
37         Web interface for the AUR.
39 Links
40 -----
42 * The official repository is hosted at git://projects.archlinux.org/aur.git --
43   see HACKING for information on submitting patches.
45 * Discovered bugs can be submitted to the AUR bug tracker:
46   https://bugs.archlinux.org/index.php?project=2
48 * Questions, comments, and patches related to the AUR can be sent to the AUR
49   development mailing list: aur-dev@archlinux.org -- mailing list archives:
50   https://mailman.archlinux.org/mailman/listinfo/aur-dev