From 30a808474554402f76dc1a217e7f05477f0e34a0 Mon Sep 17 00:00:00 2001
From: "Lange, Dr. Herbert" <herbert.lange@uni-hamburg.de>
Date: Thu, 14 Apr 2022 15:56:47 +0200
Subject: [PATCH] extend refco readme

---
 doc/README.RefCo.md | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/doc/README.RefCo.md b/doc/README.RefCo.md
index 10a905be..043aa8a0 100644
--- a/doc/README.RefCo.md
+++ b/doc/README.RefCo.md
@@ -1,6 +1,11 @@
-The Refco Checker
+# The Refco Checker
 
-How to use:
-...
-Source:
-...
+## How to use:
+
+The RefCo checker is part of the corpus services. Compile using `mvn clean compile assembly:single` or following the instructions in [Build_with_Maven.md].
+After running `mvn assembly:single` you can run the corpus services using `java -jar target/corpus-services-1.0.jar` which gives you a list of all included checkers.
+To run the RefCo checks use the command `java -jar target/corpus-services-1.0.jar -c RefcoChecker -i <PathToYourCorpus> -o <ReportOutputFile -p refco-file=<RefCoCorpusDocumentationFile> --corpus <CorpusName>` after adjusting the pathes and file names to your corpus.
+
+## Resources:
+- The souce file for the RefCoChecker: [../src/main/java/de/uni_hamburg/corpora/validation/quest/RefcoChecker.java]
+- The RefCo documentation is available on Zenodo: [https://zenodo.org/record/5825304]
-- 
GitLab