readme

1 files changed, 42 insertions, 4 deletions

diff --git a/README.md b/README.md
index 1c84faabc..3a27d71ad 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,43 @@ This is a fork of Android Privacy Guard (APG) named APG+
 
 I will try to reintegrate the various forks and build a new stable version, which can be released to the market.
 
-# Build APG+
+# Contribute
+
+Fork APG+ and do a merge request. I will merge your changes back into the main project.
+
+# Build using Ant
+
+1. Execute "ant -Dsdk.dir=/opt/android-sdk/ -Dndk.dir=/opt/android-ndk/ release" in the folder org_adaway with the appropriate paths. 
+
+1. Alternatively you could add a file local.properties in org_adaway folder with the following lines, altered to your locations of the SDK and NDK:
+
+    sdk.dir=/opt/android-sdk
+    ndk.dir=/opt/android-ndk
+
+    and execute "ant release" 
+
+2. Build
+
+APG+ is using ActionBarSherlock to provide backwards compatibility.
+ActionBarSherlock
+
+1. New -> Android Project -> Create project from existing source, choose com_actionbarsherlock 
+
+# Build using Eclipse
+
+1. New -> Android Project -> Create project from existing source, choose org_apg
+2. Add com_actionbarsherlock as Android Lib (Properties of org_apg -> Android -> Library -> add)
+3. Add Java libs (Properties of org_apg -> Java Build Path -> Libraries -> add all libraries from libs folder in org_apg)
+4. Now APG+ can be build 
+
+# Libraries
+
+The Libraries are provided in the git repository.
+
+* ActionBarSherlock to provide an ActionBar for Android < 3.0
+* Spongy Castle as the main Crypto Lib
+* android-support-v4.jar: Compatibility Lib
+* android-integration-supportv4.jar: Barcode Scanner Integration
 
 # Build XZing Integration Library
 
@@ -16,9 +52,11 @@ I will try to reintegrate the various forks and build a new stable version, whic
 
 On error see: http://code.google.com/p/zxing/issues/detail?id=1207
 
-# Build SpongyCastle
+# Build Spongy Castle
 
 see https://github.com/rtyley/spongycastle
 
-# Dashboard Icons pressed
-Inkscape -> Extensions -> Color -> darker (2 times!)
\ No newline at end of file
+# Generate pressed dashboard icons 
+
+1. Open svg in Inkscape
+2. Extensions -> Color -> darker (2 times!)
\ No newline at end of file