summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKevin Morris <kevr@0cost.org>2020-12-22 07:33:46 +0100
committerLukas Fleischer <lfleischer@archlinux.org>2021-02-20 17:55:29 +0100
commit3ecee639ac5332978647572028339f06658f2beb (patch)
tree1bf08e077d2de57a637769d7cfa4f44a0410c701 /README.md
parentf6cbb433efd89090764921a74da490427e268118 (diff)
downloadaur-3ecee639ac5332978647572028339f06658f2beb.tar.gz
aur-3ecee639ac5332978647572028339f06658f2beb.tar.xz
update documentation for FastAPI tests and deps.
Additionally, we now ask for two more favors from contributors: 1. All source modified or added within a patchset **must** maintain equivalent or increased coverage by providing tests that use the functionality. 2. Please keep your source within an 80 column width. PS: Sneak a few test Makefile and gitlab fixes. Signed-off-by: Kevin Morris <kevr@0cost.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index 77f3b13d..7521b4d9 100644
--- a/README.md
+++ b/README.md
@@ -19,12 +19,14 @@ Directory Layout
* `aurweb`: aurweb Python modules, Git interface and maintenance scripts
* `conf`: configuration and configuration templates
+* `static`: static resource files
+* `templates`: jinja2 template collection
* `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
+* `web`: PHP-based web interface for the AUR
Links
-----
@@ -46,3 +48,8 @@ Translations are welcome via our Transifex project at
https://www.transifex.com/lfleischer/aurweb; see `doc/i18n.txt` for details.
![Transifex](https://www.transifex.com/projects/p/aurweb/chart/image_png)
+
+Testing
+-------
+
+See [test/README.md](test/README.md) for details on dependencies and testing.