Skip to content
Snippets Groups Projects
Commit a04dd9a5 authored by Lange, Dr. Herbert's avatar Lange, Dr. Herbert
Browse files

Merge branch 'feature/new-checkers' into 'develop'

update readme and fix links

See merge request !5
parents da10b0d5 c4d2531a
No related branches found
No related tags found
1 merge request!5update readme and fix links
Pipeline #11570 passed
...@@ -2,10 +2,22 @@ ...@@ -2,10 +2,22 @@
## How to use: ## 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]. The RefCo checker is part of the corpus services.
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. ### Download
Releases are available on Gitlab: [https://gitlab.rrz.uni-hamburg.de/bba1792/corpus-services/-/releases](https://gitlab.rrz.uni-hamburg.de/bba1792/corpus-services/-/releases)
### Compiling
To get the most recent version you can compile corpus services yourself. Compile using `mvn clean compile assembly:single` or following the instructions in [Build_with_Maven.md](Build_with_Maven.md). After running `mvn assembly:single` you can find `corpus-services-1.0.jar` in the `target/` folder.
### Running
You can run the corpus services using `java -jar corpus-services-1.0.jar` which gives you a list of all included checkers.
To run the RefCo checks use the command `java -jar 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: ## 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] - The souce file for the RefCoChecker: [../src/main/java/de/uni_hamburg/corpora/validation/quest/RefcoChecker.java](../src/main/java/de/uni_hamburg/corpora/validation/quest/RefcoChecker.java)
- The RefCo documentation is available on Zenodo: [https://zenodo.org/record/5825304](https://zenodo.org/record/5825304)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment