commit 3cf8c2c09fea79806ce5774a682468bcbf55afe0
parent 3288a7aa23f02f9fa8c401aa457eebd42443c5df
Author: Vint Leenaars <vl.software@leenaa.rs>
Date: Thu, 8 May 2025 22:34:29 +0200
Update README
Diffstat:
| M | README.md | | | 35 | ++++++++++++++++++++++++----------- |
1 file changed, 24 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
@@ -7,12 +7,9 @@ SPDX-License-Identifier: EUPL-1.2
# KYCheck
-KYCheck is a Counter Terrorist Financing (CTF) tool written in Haskell.
-
-Uses data from the Swiss [State Secretariat for Economic Affairs](https://www.seco.admin.ch/) (SECO)
-
-Most recent [XML sanction list](https://www.sesam.search.admin.ch/sesam-search-web/pages/downloadXmlGesamtliste.xhtml?lang=en&action=downloadXmlGesamtlisteAction) can be found here.
+KYCheck is a Counter Terrorist Financing (CTF) sanction processing tool written in Haskell. It can be used for compliance processes in software such as [GNU Taler](https://taler.net).
+The most recent [XML sanction list](https://www.sesam.search.admin.ch/sesam-search-web/pages/downloadXmlGesamtliste.xhtml?lang=en&action=downloadXmlGesamtlisteAction) should be [downloaded](https://www.sesam.search.admin.ch/sesam-search-web/pages/downloadXmlGesamtliste.xhtml?lang=en&action=downloadXmlGesamtlisteAction) from the Swiss [State Secretariat for Economic Affairs](https://www.seco.admin.ch/) (SECO). In the future additional sanction lists can be added.
## Installation
@@ -26,7 +23,7 @@ $ nix-shell
## Stack configuration
-Currently the [stack configuration](./stack.yaml) is set for GHC version 9.6.6. If you have a different version installed, that probably is perfectly fine, but you need to change some things.
+Currently the [stack configuration](./stack.yaml) is set for GHC version 9.6.6. If you have a different version installed, that is likely perfectly fine - but you'll need to change some things.
First, find out what version of GHC you are working with:
@@ -34,9 +31,9 @@ First, find out what version of GHC you are working with:
ghc --version
```
-Then look up which version of LTS (Long Term Support) Haskell packages matches to your version of GHC. You can find an overview on the [website of Stackage](https://www.stackage.org/).
+Then look up which version of LTS (Long Term Support) Haskell packages matches your version of GHC. You can find an overview on [Stackage](https://www.stackage.org/).
-Change your [stack.yaml](./stack.yaml):
+Update your [stack.yaml](./stack.yaml):
```
snapshot: lts-22.43
@@ -48,14 +45,30 @@ Should become
snapshot: lts-YOUR.VERSION
```
+## Install and run
+
+Once stack is installed, we can install `kycheck` with the command:
+
+```
+$ stack install --local-bin-path DESTINATION_FOLDER
+```
+
+If you do not specify a path, the binary will be placed in `~/.local/bin` by default. This means you can run it from there or copy it to the desired location afterwards as well.
+
+```
+~/.local/bin/kycheck --help
+
+```
+
## Testing
-Once stack is installed we can run all the implemented tests:
+There are a lot of tests included. If you want to make sure that everything works as advertised, run all the implemented tests via this command:
```
$ stack test
```
-## Running
-
## Updating
+
+Update the repository, and repeat the above steps.
+
