summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBoss Marco <bossm8@students.bfh.ch>2019-12-24 17:12:12 +0100
committerBoss Marco <bossm8@students.bfh.ch>2019-12-24 17:12:12 +0100
commitd53044f1fe2e0bb8d30a8895f826aa2cc75272bb (patch)
treeab1eac112e164f15c6abdde78c0ee95d52b7ea11 /README
parent9ef6c44fc8fa36c069234c115863d2398f64eb4c (diff)
downloadtaler-mdb-d53044f1fe2e0bb8d30a8895f826aa2cc75272bb.tar.gz
taler-mdb-d53044f1fe2e0bb8d30a8895f826aa2cc75272bb.tar.bz2
taler-mdb-d53044f1fe2e0bb8d30a8895f826aa2cc75272bb.zip
updated readme
Diffstat (limited to 'README')
-rw-r--r--README49
1 files changed, 28 insertions, 21 deletions
diff --git a/README b/README
index 0d991cf..3afe614 100644
--- a/README
+++ b/README
@@ -1,43 +1,50 @@
-# Project: GNU Taler snack machine
+# GNU Taler snack machine
#### Author(s)
* BOSS Marco
* HOFER Dominik
* GROTHOFF Christian
-#### Prerequisite
+#### Prequisites
* GNU gcc tool-chain
* C standard libraries
* libnfc
- * libcurl
- * pthread
+ * libcurl/libgnurl
+ * libjansson
* GNU make
- * GNUnet
+ * GNUNet
* GNU Taler (exchange + merchant)
+ * libqrencode (optional)
#### Tested on
* Ubuntu LTS (18.04)
+ * Raspian Lite (4.19)
-#### Description
- This is a app to run a snack machine as Taler merchant with NFC payment interface.
+#### Hardware used for prototype
+ * Raspberry Pi 3B+
+ * ACR122U NFC USB reader
+ * MDB/ICP Converter from Shanghai Wafer Microelectronics
+ * Adafruit PiTFT 3.5" display
-#### Tasks
- Improve documentation
- Integration testing
+#### Description
+This is a app to run a snack machine as Taler merchant with NFC payment interface.
+Optionally there can a QRCode be shown on a display to get the payment link.
#### Remarks
- * When using an ACR122 device there may be problems with libnfc, see libnfc for further information
+ * When using an ACR122 device there may be problems with libnfc.
+ [see here](https://github.com/nfc-tools/libnfc) for further information
+ * At the moment there is no option to cross compile
-#### Noticeable points
- * Taler wallet does not receive a second message when the payment was aborted, the wallet
- has to be started again to receive a message via nfc
- * Wallet does not show succes url string
+#### Build
+Building should be easily done with the following three commands:
+ ```bash
+ ./bootstrap
+ ./configure
+ make
+ ```
-===================
+#### Configuration
+To configure the merchants backend and the product numbers of the snack machine edit
+taler.conf file.
-TODO:
-- generate upper-case URLs once wallet supports TALER://
-- document your functions Doxygen-style, in particular
- you must document every function, every argument,
- every struct, every member of every struct