MaDgIK
/
uoa-validator-engine2
14
1
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
uoa-validator-engine2/README.md

1.3 KiB
Raw Permalink Blame History

uoa-validator-engine2

Build Status

This engine validates XML records against OpenAIRE's Guidelines.

It relies on model definitions from the uoa-validator-engine2-result-models software, included as a dependency.

Documentation

  • Code Overview: A high-level overview of the most important packages and classes in the project.
  • Logic Flow: A detailed description of the validation process, from the entry point to the final result.
  • Extending the Engine: A guide on how to create custom rules and profiles.
  • Usage Guide: Examples of how to use the validator, both from the command line and programmatically.

Install and run instructions

  • Have JDK 8 and maven installed.
  • Build with mvn clean install -U.
  • Run with java -jar target/uoa-validator-engine2-<VERSION>.jar.

License

This project is licensed under the Apache License, Version 2.0. See the LICENSE.md file for details.