commit 24f18057fdfb99b567feacfc80823d687446e660
parent 96d5f9774e48dfa26bb0382b612f8979358889ba
Author: Vint Leenaars <vl.software@leenaa.rs>
Date: Fri, 9 May 2025 01:51:58 +0200
Formatting of README
Diffstat:
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ Currently the [stack configuration](./stack.yaml) is set for GHC version 9.6.6.
First, find out what version of GHC you are working with:
```
-ghc --version
+$ ghc --version
```
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/).
@@ -56,7 +56,7 @@ $ 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
+$ ~/.local/bin/kycheck --help
```
You can either provide all the parameters on the command line, or use a configuration file (in [Dhall](https://dhall-lang.org/). There is an example configuration file called `kycheck.conf` available, with reasonably sane defaults. You can specify your own using the flag `--config`.
@@ -73,9 +73,9 @@ If there are multiple entries that match, kycheck will print all of them so you
Enter new lines with subject data until you've researched all.
-You can also check out legal entities. Using an example organisation from our tests (note that this is an example entity that is not on the sanction list, so we need to provide our own alternative 'sanction list':
+You can also check out legal entities. Using an example organisation from our tests (note that this is an example entity that is not on the sanction list, so we need to provide our own alternative 'sanction list'):
-```.local/bin/kycheck --config kycheck.example.conf --input test/data/target_1.xml```
+```$ .local/bin/kycheck --config kycheck.example.conf --input test/data/target_1.xml```
The input:
