Move documentation to a subdirectory

Create a new subdirectory doc/ that contains documentation.

Signed-off-by: Lukas Fleischer <lfleischer@archlinux.org>

2 files changed, 116 insertions, 0 deletions

diff --git a/doc/CodingGuidelines b/doc/CodingGuidelines
new file mode 100644
index 0000000..46537bb
--- /dev/null
+++ b/doc/CodingGuidelines
@@ -0,0 +1,54 @@
+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
+------------
+
+Column width: 79 columns or less within reason.
+
+Indentation: tabs (standard eight column width)
+Please don't add any mode lines. Adjust your editor to display tabs to your
+preferred width. Generally code should work with the standard eight column
+tabs.
+
+No short open tags. '<?'
+Do not end files with a close tag. '?>'
+Try embedding as little XHTML in the PHP as possible.
+Consider creating templates for XHTML.
+
+All markup should conform to XHTML 1.0 Strict requirements.
+You can use http://validator.w3.org to check the markup.
+
+Prevent PHP Notices by using isset() or empty() in conditionals that
+reference $_GET, $_POST, or $_REQUEST variables.
+
+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.
+
+You will need to register on the mailing list before submitting:
+https://mailman.archlinux.org/mailman/listinfo/aur-dev
+
+Base your patches on the master branch as forward development is done there.
+When writing patches please keep unnecessary changes to a minimum.
+
+Try to keep your commits small and focused.
+Smaller patches are much easier to review and have a better chance of being
+pushed more quickly into the main repo. Smaller commits also makes reviewing
+the commit history and tracking down specific changes much easier.
+
+Try to make your commit messages brief but descriptive.
+
+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/doc/i18n.txt b/doc/i18n.txt
new file mode 100644
index 0000000..e450640
--- /dev/null
+++ b/doc/i18n.txt
@@ -0,0 +1,62 @@
+aurweb Translation
+==================
+
+This document describes how to create and maintain aurweb translations. It was
+originally derived from https://wiki.archlinux.org/index.php/aurweb_Translation
+
+Creating an aurweb translation requires a Transifex (http://www.transifex.com/)
+account. You will need to register with a translation team on the aurweb
+project page (http://www.transifex.com/projects/p/aurweb/).
+
+
+Creating a New Translation
+--------------------------
+
+Before beginning, please sign up for an Transifex account and request the
+addition of a new translation team for the aurweb project. Also, please do not
+translate if you are unwilling to maintain or find someone to maintain the
+translation. This is due to the fact that aurweb is a rapidly evolving project
+and there are constantly new strings to be translated. If the translations get
+too out of sync with the released versions, there will be too many untranslated
+strings for the translation to be usable, and it may have to be disabled.
+
+1. Check out the aurweb source using git:
+
+$ git clone git://projects.archlinux.org/aurweb.git aurweb-git
+
+2. Go into the "po/" directory in the aurweb source and run msginit(1) to
+   create a initial translation file from our translation catalog:
+
+$ cd aur-git
+$ git checkout master
+$ git pull
+$ cd po
+$ msginit -l <locale> -o <locale>.po -i aur.pot
+
+3. Use some editor or a translation helper like poedit to add translations:
+
+$ poedit <locale>.po
+
+5. If you have a working aurweb setup, add a line for the new translation in
+   "web/lib/config.inc.php.proto" and test if everything looks right.
+
+6. Upload the newly created ".po" file to Transifex. If you don't like the web
+   interface, you can also use transifex-client to do that (see below).
+
+
+Updating an Existing Translation
+--------------------------------
+
+1. Download current translation files from Transifex. You can also do this
+   using transifex-client which is available through the AUR:
+
+$ tx pull -a
+
+2. Update the existing translation file using an editor or a tool like poedit:
+
+$ poedit po/<locale>.po
+
+3. Push the updated translation file back to Transifex. Using transifex-client,
+   this works as follows:
+
+$ tx push -r aur.aurpot -t -l <locale>