From d3955c2d8ae552c22547a186ab196274e32919e7 Mon Sep 17 00:00:00 2001 From: Torsten Grote Date: Mon, 24 Aug 2020 10:31:29 -0300 Subject: Add README files to top-level and update the project ones --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..cdc9574 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# GNU Taler Android Code Repository + +This git repository contains code for GNU Taler Android apps and libraries. +The official location is: + + https://git.taler.net/taler-android.git + +## Structure + +* [**anastasis-ui**](/anastasis-ui) - an Android library for sync and backup UI. + See [Anastasis](https://docs.taler.net/anastasis.html). +* [**cashier**](/cashier) - an Android app that enables you to take cash and give out electronic cash +* [**merchant-lib**](/merchant-lib) - a library providing communication with a merchant backend + to be used by the point of sale app below. +* [**merchant-terminal**](/merchant-terminal) - a merchant point of sale terminal Android app + that allows sellers to + process customers’ orders by adding or removing products, + calculate the amount owed by the customer + and let the customer make a Taler payment via QR code or NFC. +* [**taler-kotlin-android**](/taler-kotlin-android) - an Android library containing common code + needed by more than one Taler Android app. +* [**multiplatform**](/multiplatform) - multi-platform Taler libraries + included as a [git submodule](https://git-scm.com/docs/git-submodule) + from [`https://git.taler.net/wallet-kotlin.git`](https://git.taler.net/wallet-kotlin.git/) +* [**wallet**](/wallet) - a GNU Taler wallet Android app + +## Building + +Before building anything, you should initialize and update the submodules by running + + $ ./bootstrap + +Then, you can get a list of possible build tasks like this: + + $ ./gradlew tasks + +See the [Taler developer manual](https://docs.taler.net/developers-manual.html#build-apps-from-source). +for more information about building individual apps. -- cgit v1.2.3