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

README: Update and reformat

Browse source 
* Add information on mkaurball and metadata parsing.
* Slightly update the feature section.
* Remove the top-level directory file listing.
* Consolidate sections with links to our online presence.
* Reformat everything for consistency.

Signed-off-by: Lukas Fleischer <archlinux@cryptocrack.de>
This commit is contained in:
Lukas Fleischer 2014-02-06 18:43:17 +01:00
parent c09dcc4e98
commit 4171cdd784
1 changed files with 39 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

95
README
View file

@ -1,67 +1,50 @@
===================
Arch User Repository (AUR) Arch User Repository (AUR)
=================== ==========================
About:
=====
The Arch User Repository (AUR) is a framework for hosting a collection of The Arch User Repository (AUR) is a framework for hosting a collection of
packaging scripts that are created and submitted by the Arch community. The packaging scripts that are created and submitted by the Arch community. The
scripts contained in the repository (PKGBUILDS) can be built using the Arch scripts contained in the repository (PKGBUILDs) can be built using the AUR
building/packaging script (makepkg) and installed via the Arch pacman manager building/packaging script `mkaurball` and installed via the Arch package
(pacman). The AUR project aims to provide the necessary web interface, database manager `pacman`. The AUR project aims to provide the necessary web interface,
schema, and scripts for a multi-lingual community-driven repository. database schema, and scripts for a multi-lingual community-driven repository.
Functionality: Functionality
========= -------------
-Users may submit source packages that contain a PKGBUILD
-User accounts with varying permission levels (User, Trusted User, Developer)
-Ability to search for specific submitted packages (based on package name,
package description, package submitter, package maintainer)
-Display submitted package information by parsing PKGBUILD (description,
license, package dependencies, etc)
-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 have ability to search for and modify accounts
-Area for Trusted Users
and Developers to post AUR-related proposals and vote on them
File Hierarchy: * Users may submit source packages that contain a PKGBUILD.
========== * 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 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.
Directory Layout: Directory Layout
------------------- ----------------
./po - Translation files for strings in the AUR web
interface.
./scripts - aurblup package blacklist tool. Scripts for AUR
maintenance.
./support - Schema for SQL database. Script for dummy data generation.
./web - Web interface for the AUR.
Files: po::
------ Translation files for strings in the AUR web interface.
AUTHORS - List of maintainers, contributors, and translators for AUR
project.
COPYING - License information for AUR project (GPL version 2).
HACKING - Guidelines for modifying source and submitting
patches.
INSTALL - Installation procedure for AUR.
TODO - List of potential features and changes to be made to the AUR.
TRANSLATING - Directions for creating and updating string translations.
UPGRADING - Changes needed to upgrade older AUR version to newer version.
Code: scripts::
===== aurblup package blacklist tool. Scripts for AUR maintenance.
Official repository hosted at git://projects.archlinux.org/aur.git
See HACKING for information on submitting patches
Bugs: support::
===== Schema for SQL database. Script for dummy data generation.
Discovered bugs can be submitted to the AUR bug tracker:
https://bugs.archlinux.org/index.php?project=2
Contact: web::
======== Web interface for the AUR.
Questions, comments, and patches related to the AUR can be sent to the AUR
development mailing list: aur-dev@archlinux.org Links
Mailing list archives: https://mailman.archlinux.org/mailman/listinfo/aur-dev -----
* The official repository is hosted at git://projects.archlinux.org/aur.git --
see HACKING for information on submitting patches.
* Discovered bugs can be submitted to the AUR bug tracker:
https://bugs.archlinux.org/index.php?project=2
* Questions, comments, and patches related to the AUR can be sent to the AUR
development mailing list: aur-dev@archlinux.org -- mailing list archives:
https://mailman.archlinux.org/mailman/listinfo/aur-dev