summaryrefslogtreecommitdiffstats
path: root/documentation/readme.txt
blob: b6c6d31863acfc9eb21a9ba6734f5a75a534f3b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
aurweb
======


Name
----
aurweb - Arch User Repository


Description
-----------

aurweb is a framework for hosting the Arch User Repository (AUR), a collection
of packaging scripts that are created and submitted by the Arch Linux
community. The scripts contained in the repository (PKGBUILDs) con be built
using makepkg and installed via the Arch Linux package manager 'pacman'. The
aurweb project aims to provide the necessary web interface, database schema,
and scripts for a multi-lingual community-driven repository.


Functionality
-------------

* Users may submit PKGBUILDs by pushing a git repository containing the
  PKGBUILD and a .SRCINFO file to the AUR.
* User accounts with varying permission levels (User, Trusted User, Developer).
* Ability to search for specific submitted packages.
* Display package information by parsing meta-data provided with the packages.
* Users can make comments on package information pages.
* Users can mark packages as out-of-date.
* Vote for well-done and popular user submitted packages.
* Trusted Users and Developers can search for and modify accounts.
* Area for Trusted Users to post AUR-related proposals and vote on them.


Directory Layout
----------------

po::
	Translation files for strings in the aurweb interface.

scripts::
	Scripts for AUR maintenance.

support::
	Schema for the SQL database. Script for dummy data generation.

web::
	Web interface for the AUR

git-integration::
	Git interface for the AUR


Links
-----

* The repository is hosted at git://projects.archlinux.org/aurweb.git -- see
  HACKING for information on submitting patches.

* Discovered bugs can be submitted to the aurweb bug tracker:
  <https://bugs.archlinux.org/index.php?project=2>

* Questions, comments, and patches related to aurweb can be sent to the AUR
  development mailing list: mailto:aur-dev@archlinux.org -- mailing list
  archives: <https://mailman.archlinux.org/mailman/listinfo/aur-dev>


Bugs
----
Bugs? You must be kidding; there are no bugs in this software. But if we
happen to be wrong, send us an email with as much detail as possible to
mailto:aur-dev@archlinux.org.


Maintainers
-----------

* Lukas Fleischer <lfleischer@archlinux.org>
* Johannes Löthberg <johannes@kyriasis.com>


Past Maintainers
----------------

* canyonknight <canyonknight@gmail.com> '(2013-2014)'
* Loui Chang <louipc.ist@gmail.com> '(2008-2011)'
* Callan Barrett <wizzomafizzo@gmail.com> '(2008-2009)'
* eliott <eliott@cactuswax.net> '(2007-2009)'
* Paul Mattal <paul@mattal.com> '(2007)'
* Simo Leone <simo@archlinux.org> '(2005-2008)'
* Eric Johnson '(2004-2005)'


Contributors
------------

For a list of contributors, use +git shortlog -s+ on the aurweb.git repository.


/////
vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
/////