external/aurweb
0
0
Fork 0
mirror of https://gitlab.archlinux.org/archlinux/aurweb.git synced 2025-02-03 10:43:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README

Browse source 
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>
This commit is contained in:
Lukas Fleischer 2016-06-08 22:20:54 +02:00
parent 333596ab4a
commit 9fec03d655
1 changed files with 24 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README
View file

@ -1,40 +1,42 @@
aurweb aurweb
====== ======
aurweb is a framework for hosting the Arch User Repository (AUR), a collection 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 of packaging scripts that are created and submitted by the Arch Linux
community. The scripts contained in the repository (PKGBUILDs) can be built community. The scripts contained in the repository can be built using `makepkg`
using makepkg and installed via the Arch Linux package manager pacman. The and installed using the Arch Linux package manager `pacman`.
aurweb project aims to provide the necessary web interface, database schema,
and scripts for a multi-lingual community-driven repository.
Functionality The aurweb project includes
-------------
* Users may submit source packages that contain a PKGBUILD. * A web interface to search for packaging scripts and display package details.
* User accounts with varying permission levels (User, Trusted User, Developer). * A SSH/Git interface to submit and update packages and package meta data.
* Ability to search for specific submitted packages. * Community features such as comments, votes, package flagging and requests.
* Display package information by parsing meta-data provided with the packages. * Editing/deletion of packages and accounts by Trusted Users and Developers.
* Users can make comments on package information page.
* Mark packages as out-of-date.
* Vote for well-done and popular user submitted packages.
* Trusted User and Developer can search for and modify accounts.
* Area for Trusted Users to post AUR-related proposals and vote on them. * Area for Trusted Users to post AUR-related proposals and vote on them.
Directory Layout Directory Layout
---------------- ----------------
conf::
Configuration and configuration templates.
doc:: doc::
aurweb documentation. Project documentation.
git-interface::
Scripts that make up the Git and SSH interface.
po:: po::
Translation files for strings in the aurweb interface. Translation files for strings in the aurweb interface.
scripts:: schema::
aurblup package blacklist tool. Scripts for AUR maintenance. Schema for the SQL database. Script for dummy data generation.
support:: scripts::
Schema for SQL database. Script for dummy data generation. Scripts for AUR maintenance.
upgrading::
Instructions for upgrading setups from one release to another.
web:: web::
Web interface for the AUR. Web interface for the AUR.
@ -43,9 +45,9 @@ Links
----- -----
* The repository is hosted at git://git.archlinux.org/aurweb.git -- see * The repository is hosted at git://git.archlinux.org/aurweb.git -- see
doc/CodingGuidelines for information on submitting patches. doc/CodingGuidelines for information on the patch submission process.
* Discovered bugs can be submitted to the aurweb bug tracker: * Bugs can (and should) be submitted to the aurweb bug tracker:
https://bugs.archlinux.org/index.php?project=2 https://bugs.archlinux.org/index.php?project=2
* Questions, comments, and patches related to aurweb can be sent to the AUR * Questions, comments, and patches related to aurweb can be sent to the AUR