summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLukas Fleischer <lfleischer@archlinux.org>2020-02-10 15:25:03 +0100
committerLukas Fleischer <lfleischer@archlinux.org>2020-02-11 12:19:56 +0100
commit3f2654e79e70caa828f3464386b0a3367cbac758 (patch)
tree8902cec04eb00204a7f21552c16056732fbf6c5b
parentd4632aaffa062de7cdc03c3e33e13fa0d9e77317 (diff)
downloadaur-3f2654e79e70caa828f3464386b0a3367cbac758.tar.gz
aur-3f2654e79e70caa828f3464386b0a3367cbac758.tar.xz
Update README and convert to Markdown syntax
Signed-off-by: Lukas Fleischer <lfleischer@archlinux.org>
-rw-r--r--README.md (renamed from README)34
1 files changed, 8 insertions, 26 deletions
diff --git a/README b/README.md
index e633ec3f..a4ab584e 100644
--- a/README
+++ b/README.md
@@ -17,32 +17,14 @@ The aurweb project includes
Directory Layout
----------------
-aurweb::
- aurweb Python modules.
-
-conf::
- Configuration and configuration templates.
-
-doc::
- Project documentation.
-
-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.
-
-test::
- Test suite and test cases.
-
-upgrading::
- Instructions for upgrading setups from one release to another.
-
-web::
- Web interface for the AUR.
+* `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
-----