aurweb/README
Lukas Fleischer 9fec03d655 Update README
Reword most parts of the README file, add information on new features
and update the directory layout.

Signed-off-by: Lukas Fleischer <lfleischer@archlinux.org>
2016-06-08 22:23:57 +02:00

55 lines
1.6 KiB
Text

aurweb
======
aurweb is a hosting platform for 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 can be built using `makepkg`
and installed using the Arch Linux package manager `pacman`.
The aurweb project includes
* A web interface to search for packaging scripts and display package details.
* A SSH/Git interface to submit and update packages and package meta data.
* Community features such as comments, votes, package flagging and requests.
* Editing/deletion of packages and accounts by Trusted Users and Developers.
* Area for Trusted Users to post AUR-related proposals and vote on them.
Directory Layout
----------------
conf::
Configuration and configuration templates.
doc::
Project documentation.
git-interface::
Scripts that make up the Git and SSH interface.
po::
Translation files for strings in the aurweb interface.
schema::
Schema for the SQL database. Script for dummy data generation.
scripts::
Scripts for AUR maintenance.
upgrading::
Instructions for upgrading setups from one release to another.
web::
Web interface for the AUR.
Links
-----
* The repository is hosted at git://git.archlinux.org/aurweb.git -- see
doc/CodingGuidelines for information on the patch submission process.
* Bugs can (and should) 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: aur-dev@archlinux.org -- mailing list archives:
https://mailman.archlinux.org/mailman/listinfo/aur-dev