summaryrefslogtreecommitdiff
path: root/wallet/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'wallet/README.md')
-rw-r--r--wallet/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/wallet/README.md b/wallet/README.md
new file mode 100644
index 0000000..63b128b
--- /dev/null
+++ b/wallet/README.md
@@ -0,0 +1,40 @@
+GNU Taler Wallet
+================
+
+This package implements a GNU Taler wallet for Android.
+It is currently a UI for the wallet writen in TypeScript.
+
+
+Building
+========
+
+Currently, building the wallet for Android requires manually copying two
+dependencies:
+
+`akono.aar` -> `../akono/akono.aar`
+`taler-wallet-android.js` -> `src/main/assets/taler-wallet-android.js`
+
+After that, the Android wallet can be built with Gradle:
+
+ $ ./gradlew build
+
+
+Obtaining Dependencies
+======================
+
+There are two ways of obtaining the dependencies. The easiest one is
+to use the pre-built versions, which are stored in the "binary-deps"
+branch of this repository.
+
+An easy way to access them is using a git worktree:
+
+ $ git fetch origin binary-deps
+ $ git worktree add binary-deps binary-deps
+ $ cp binary-deps/akono.aar ../akono/akono.aar
+ $ cp binary-deps/taler-wallet-android.js src/main/assets/taler-wallet-android.js
+ $ git worktree remove binary-deps
+
+Alternatively, you can build them yourself from the respective repositories:
+
+ * git://git.taler.net/akono.git
+ * git://git.taler.net/wallet-core.git