From e5b21205bf27076e1460e6a60570f877ff69cf17 Mon Sep 17 00:00:00 2001
From: Torsten Grothoff <tg@wafflepowered.com>
Date: Sun, 23 Aug 2020 11:14:01 +0200
Subject: Add License and a bit of documentation.

---
 README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5a0b0c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,67 @@
+# Taler Merchant Demos Setup
+*Warning: This page is not completed yet. Follow the instructions at your own risk*
+## Installing the dependencies
+Step 1: `cd` into the directory:<br/>
+
+> ```$ cd taler-merchant-demos```
+
+<br/>
+Step 2: configure it using:<br/>
+
+> ```$ ./configure --destination=local```
+
+<br/>
+Step 3: Ensure Python3.5 or above is installed using a command like:<br/>
+
+> ```$ sudo apt install python3.8 -y```
+
+<br/>
+Step 4: Ensure Python3 Pip is installed:<br/>
+
+> ```$ sudo apt install python3-pip -y```
+
+Step 5: Install UWSGI<br>
+*NOTE: DO NOT INSTALL USING PIP2 (on my system, that is what the pip command uses) - INSTALL IT USING PIP3*
+
+> ```$ pip3 install uwsgi```
+
+<br/>
+Step 6: Install LXML
+*NOTE: DO NOT INSTALL USING PIP2 (on my system, that is what the pip command uses) - INSTALL IT USING PIP3*
+
+> ```pip3 install lxml```
+<br>
+
+## Configuring the demo
+*This is just how I did it, and not the main method of doing it*
+
+Step 1: Open the config:
+
+> ```$ editor ~/.config/taler.conf```
+<br>
+
+Step 2: Adding the required keys:
+> Copy & Paste the following into the file:
+> ```
+> [frontends]
+> backend_apikey = "ApiKey Sandbox"
+> backend = https://backend.test.taler.net/
+> 
+> [taler]
+> currency = TESTKUDOS
+> 
+> [blog]
+> http_port = 8080
+> ```
+<br>
+
+Step 3: Configure the config:
+> 1. Replace the backend api key with the api key for the backend<br>
+> 2. Replace the backend URL with the actual backend link<br>
+> 3. Replace the http port with the port<br>
+> 4. (Optional: Replace the currency with your currency)
+<br>
+
+## Running the program
+To start the server, use the following command:<br>
+> ```taler-merchant-demos --serve-http blog```
\ No newline at end of file
-- 
cgit v1.2.3