summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLukas Fleischer <lfleischer@archlinux.org>2015-07-22 13:49:51 +0200
committerLukas Fleischer <lfleischer@archlinux.org>2015-08-08 12:59:24 +0200
commitab2577525970e415f9ad2439ae1bb2c51f479c8a (patch)
treeb83526e0fea39f5f528bfe9d7a39c3f25e84d489
parent080b6f3d123c465f70a8f9f1e724111dd1b3cf56 (diff)
downloadaurweb-ab2577525970e415f9ad2439ae1bb2c51f479c8a.tar.xz
Move documentation to a subdirectory
Create a new subdirectory doc/ that contains documentation. Signed-off-by: Lukas Fleischer <lfleischer@archlinux.org>
-rw-r--r--AUTHORS4
-rw-r--r--README5
-rw-r--r--doc/CodingGuidelines (renamed from HACKING)10
-rw-r--r--doc/i18n.txt (renamed from TRANSLATING)0
4 files changed, 12 insertions, 7 deletions
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
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
index e450640..e450640 100644
--- a/TRANSLATING
+++ b/doc/i18n.txt