From 3f2654e79e70caa828f3464386b0a3367cbac758 Mon Sep 17 00:00:00 2001 From: Lukas Fleischer Date: Mon, 10 Feb 2020 15:25:03 +0100 Subject: [PATCH] Update README and convert to Markdown syntax Signed-off-by: Lukas Fleischer --- README => README.md | 34 ++++++++-------------------------- 1 file changed, 8 insertions(+), 26 deletions(-) rename README => README.md (73%) diff --git a/README b/README.md similarity index 73% rename from README rename to 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 -----