Create a new subdirectory doc/ that contains documentation. Signed-off-by: Lukas Fleischer <lfleischer@archlinux.org> --- AUTHORS | 4 ++-- README | 5 ++++- HACKING => doc/CodingGuidelines | 10 ++++++---- TRANSLATING => doc/i18n.txt | 0 4 files changed, 12 insertions(+), 7 deletions(-) rename HACKING => doc/CodingGuidelines (96%) rename TRANSLATING => doc/i18n.txt (100%) diff --git a/AUTHORS b/AUTHORS index a21fef7..4462cab 100644 --- a/AUTHORS +++ b/AUTHORS @@ -23,8 +23,8 @@ Use `git shortlog -s` for a list of aurweb contributors. Translations ------------ -Our translations are currently maintained in Transifex; please read TRANSLATING -for more details. +Our translations are currently maintained in Transifex; please read +doc/i18n.txt for more details. Below is a list of past translators before we switched to Transifex; more can be found by looking in the Git history. diff --git a/README b/README index 228358a..71e8481 100644 --- a/README +++ b/README @@ -24,6 +24,9 @@ Functionality Directory Layout ---------------- +doc:: + aurweb documentation. + po:: Translation files for strings in the aurweb interface. @@ -40,7 +43,7 @@ Links ----- * The repository is hosted at git://projects.archlinux.org/aurweb.git -- see - HACKING for information on submitting patches. + doc/CodingGuidelines for information on submitting patches. * Discovered bugs can be submitted to the aurweb bug tracker: https://bugs.archlinux.org/index.php?project=2 diff --git a/HACKING b/doc/CodingGuidelines similarity index 96% rename from HACKING rename to doc/CodingGuidelines index 291da1f..46537bb 100644 --- a/HACKING +++ b/doc/CodingGuidelines @@ -1,11 +1,13 @@ -HACKING +Coding Guidelines +================= DISCLAIMER: We realise the code doesn't necessarily follow all the rules. This is an attempt to establish a standard coding style for future development. -Coding style guidelines ------------------------ +Coding style +------------ + Column width: 79 columns or less within reason. Indentation: tabs (standard eight column width) @@ -28,6 +30,7 @@ MySQL queries should generally go into functions. Submitting patches ------------------ + !!! PLEASE TEST YOUR PATCHES BEFORE SUBMITTING !!! Submit uncompressed git-formatted patches to aur-dev@archlinux.org. @@ -49,4 +52,3 @@ Glossary git-formatted patch: A patch that is produced via `git format-patch` and is sent via `git send-email` or as an inline attachment of an email. - diff --git a/TRANSLATING b/doc/i18n.txt similarity index 100% rename from TRANSLATING rename to doc/i18n.txt -- 2.4.6