diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..a4ab584e --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +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 +---------------- + +* `aurweb`: aurweb Python modules, Git interface and maintenance scripts +* `conf`: configuration and configuration templates +* `doc`: project documentation +* `po`: translation files for strings in the aurweb interface +* `schema`: schema for the SQL database +* `test`: test suite and test cases +* `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 |