commit 0d619bb9313d4b8503f85e8b2c4ca660682c7c26
parent 31894d1714a8de799fa58bed8e35c44bb94aa10a
Author: Joel-Haeberli <haebu@rubigen.ch>
Date: Wed, 29 May 2024 17:05:57 +0200
fix: README
Diffstat:
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/c2ec/README b/c2ec/README
@@ -1,22 +1,28 @@
# C2EC
The cashless2ecash (C2EC) component, allows withdrawing taler in an indirect
-transaction. This means that the reserve is created if a trusted third party
-called the `provider` attests, that the payment was successful and the withdrawal
+transaction. This means that the reserve is created if a payment system provider
+called the `provider` confirms, that the payment was successful and the withdrawal
can be executed.
## Build, Config, Run
### Build
+IMPORTANT: You need at least Go v1.22!
+
To build the executable, simply run `go build .` inside the `c2ec`-directory.
### Config
By default, the C2EC executable will look for a config file called
`c2ec-config.yaml` in the directory it is executed. If you want to run C2EC with
-a config located somewhere else, supply the path to the config file as the first
-argument on startup.
+a config located somewhere else, supply the path to the config file like:
+
+`./c2ec -c my-custom-conf.conf`
+
+`c2ec` understands the .ini format. The default configuration is also available in .ini
+format.
### Running
@@ -26,7 +32,7 @@ To run the application just execute the binary built during the build step above
With non-default config:
-`./c2ec /my/custom/config/location.yaml`
+`./c2ec -c /my/custom/config/location.yaml`
## Adding Providers and Terminals
@@ -62,7 +68,3 @@ run `rt`. It will ask you for two things:
2. the name of the provider, which the device belongs to. In the simulation case this will MUST be `Simulation`.
Be aware that a terminal can only be added, after the provdier it belongs to was added.
-
-### Run the Simulation
-
-To run the simulation,
