Update wiki links to the new short URL
[aur.git] / README.md
blob77f3b13d049ea9c946d6720090dc025deedd98e3
1 aurweb
2 ======
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`.
9 The aurweb project includes
11 * A web interface to search for packaging scripts and display package details.
12 * An 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.
17 Directory Layout
18 ----------------
20 * `aurweb`: aurweb Python modules, Git interface and maintenance scripts
21 * `conf`: configuration and configuration templates
22 * `doc`: project documentation
23 * `po`: translation files for strings in the aurweb interface
24 * `schema`: schema for the SQL database
25 * `test`: test suite and test cases
26 * `upgrading`: instructions for upgrading setups from one release to another
27 * `web`: web interface for the AUR
29 Links
30 -----
32 * The repository is hosted at git://git.archlinux.org/aurweb.git -- see
33   doc/CodingGuidelines for information on the patch submission process.
35 * Bugs can (and should) be submitted to the aurweb bug tracker:
36   https://bugs.archlinux.org/index.php?project=2
38 * Questions, comments, and patches related to aurweb can be sent to the AUR
39   development mailing list: aur-dev@archlinux.org -- mailing list archives:
40   https://mailman.archlinux.org/mailman/listinfo/aur-dev
42 Translations
43 ------------
45 Translations are welcome via our Transifex project at
46 https://www.transifex.com/lfleischer/aurweb; see `doc/i18n.txt` for details.
48 ![Transifex](https://www.transifex.com/projects/p/aurweb/chart/image_png)