aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDominik Schürmann <dominik@dominikschuermann.de>2013-07-23 22:15:26 +0200
committerDominik Schürmann <dominik@dominikschuermann.de>2013-07-23 22:15:26 +0200
commit178bd7f4feb56af007e3515703bcacffa25f7b39 (patch)
tree61569a05e60aea4c25935811fa67e47c412746e4 /README.md
parentf608fc123fbd23bce1f8ab12c927b1b9fc9d619c (diff)
downloadopen-keychain-178bd7f4feb56af007e3515703bcacffa25f7b39.tar.gz
open-keychain-178bd7f4feb56af007e3515703bcacffa25f7b39.tar.bz2
open-keychain-178bd7f4feb56af007e3515703bcacffa25f7b39.zip
Add coding style to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 519b533c2..1d6956b7d 100644
--- a/README.md
+++ b/README.md
@@ -134,6 +134,24 @@ AIDL service
### ApgKeyService (Remote Service)
AIDL service to access actual private keyring objects
+# Coding Style
+
+## Code
+* Indentation: 4 spaces, no tabs
+* Maximum line width for code and comments: 100
+* Opening braces don't go on their own line
+* Field names: Non-public, non-static fields start with m.
+* Acronyms are words: Treat acronyms as words in names, yielding !XmlHttpRequest, getUrl(), etc.
+
+See http://source.android.com/source/code-style.html
+
+## XML Eclipse Settings
+* XML Maximum line width 999
+* XML: Split multiple attributes each on a new line (Eclipse: Properties -> XML -> XML Files -> Editor)
+* XML: Indent using spaces with Indention size 4 (Eclipse: Properties -> XML -> XML Files -> Editor)
+
+See http://www.androidpolice.com/2009/11/04/auto-formatting-android-xml-files-with-eclipse/
+
# Licenses
OpenPGP Kechain is licensed under Apache License v2.