readme

1 files changed, 63 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..9bdc8fa
--- /dev/null
+++ b/README
@@ -0,0 +1,63 @@
+Installation instructions
+-------------------------
+
+First, initialize the configure script.
+
+$ ./bootstrap
+
+Then, choose the installation prefix
+
+$ ./configure --prefix=<prefix>
+
+Last, install
+
+$ make install
+
+Optionally, to run tests:
+
+$ make check
+
+Configuration options.
+----------------------
+
+The following configuration excerpt shows all the options
+accepted by the donations shop.
+
+$ cat ~/.config/taler.conf
+
+[frontends]
+
+# Merchant backend to use.
+backend = http://backend.test.taler.net/
+
+# This value will fill: "Authorization: ApiKey <fill here>"
+backend_apikey = sandbox
+
+[donations]
+
+# The following three options configure the way the blog
+# will serve UWSGI requests via unix domain sockets.
+uwsgi_serve = unix
+uwsgi_unixpath = /path/to/blog.uwsgi
+uwsgi_unixpath_mode = 660
+
+# The following option picks the merchant instance that
+# will be represented by the running blog.
+instance = default
+
+Running instructions
+--------------------
+
+The following command launches the blog to serve HTTP requests
+on the port <port>.
+
+$ taler-merchant-donations serve-http -p <port>
+
+The following command launches the blog to serve UWSGI requests
+via a unix domain socket.
+
+$ taler-merchant-donations serve-uwsgi
+
+Finally, get a help message with the following command
+
+$ taler-merchant-donations --help