diff options
| author | Christian Grothoff <christian@grothoff.org> | 2024-11-15 12:04:40 +0100 |
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2024-11-15 12:04:40 +0100 |
| commit | cb7b80b59bbf3309256348f3829e315da563e277 (patch) | |
| tree | 1dc65617cbb5da6b3f7d3e092499fb76800c9431 /README | |
| parent | 0869773b5cc3aca0edf675e29294d560631e86ac (diff) | |
list build dependencies in README
Diffstat (limited to 'README')
| -rw-r--r-- | README | 68 |
1 files changed, 56 insertions, 12 deletions
@@ -29,20 +29,64 @@ instructions on how to do so at http://www.gnu.org/help/evaluation. We are looking forward to hacking with you! -Installation -============ +Dependencies: +============= -libjansson: MIT License, AGPL- and LGPL-Compatible, owned by Petri Lehtinen and other individuals -libgcrypt: LGPL, owned by Free Software Foundation -postgresql: PostgreSQL License, AGPL- and LGPL-Compatible, owned by The PostgreSQL -Global Development Group -libgnunetutil (in all of its variants): GPLv3+, owned by GNUnet e.V. -libqrencode: LGPL v2.1+, Copyright Kentaro Fukuchi +Build tools for compiling Taler merchant from source: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +- gcc or clang +- autoconf >= 2.69 (building from git) +- automake >= 1.11.1 (building from git) +- recutils >= 1.0 (building from git) +- libtool >= 2.2 +- makeinfo >= 4.8 +- make[*3] +- pkgconf or pkg-config +- sphinx +- sphinx-rtd-theme +- sphinx-multiversion -Source guide -============ -'src/' contains the "backend", a C piece of software which implements crypto routines +Direct dependencies +~~~~~~~~~~~~~~~~~~~ + +These are the direct dependencies for running a Taler exchange: + +- GNU Taler exchange >= 0.14.0 +- PostgreSQL >= 15.0 +- libqrencode + + +Project structure +================= + +src/backend/ + contains the "backend", a C piece of software which implements crypto routines and communication with the 'exchange' -'doc/' contains documentation files, like TeXinfo + +src/backenddb/ + contains the database interactions (for now only PostgreSQL) + +src/lib/ + contains a C API to talk to the REST API of merchant backend + +src/util/ + common utility functions + +src/bank/ + utility functions to talk to the Taler bank revenue API to + reconcile transactions + +src/merchant-tools/ + contains helper programs to setup or manipulate the merchant backend + +src/testing/ + contains test cases for the merchant backend + +doc/ + contains documentation files, like TeXinfo + +contrib/ + contains the single-page-app (Web interface) as a submodule, + as well as CI/CD logic. |