From c2c688dfd794ecf33c9580c915ba983c7f459546 Mon Sep 17 00:00:00 2001
From: hoangtungdinh <11166240+hoangtungdinh@users.noreply.github.com>
Date: Tue, 27 Aug 2024 17:56:19 +0200
Subject: [PATCH] Add example config file

Signed-off-by: hoangtungdinh <11166240+hoangtungdinh@users.noreply.github.com>
---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index 8ac89c0..506d97a 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,7 @@ This project implements the [ASAM OpenDrive Checker Bundle](checker_bundle_doc.m
   - [Register Checker Bundle to ASAM Quality Checker Framework](#register-checker-bundle-to-asam-quality-checker-framework)
     - [Linux Manifest Template](#linux-manifest-template)
     - [Windows Manifest Template](#windows-manifest-template)
+    - [Example Configuration File](#example-configuration-file)
   - [Tests](#tests)
     - [Execute tests](#execute-tests)
   - [Contributing](#contributing)
@@ -150,6 +151,31 @@ If the asam-qc-opendrive is installed in a virtual environment, the `exec_comman
 
 Replace `C:\\> <venv>\\Scripts\\activate.bat` by the path to your virtual environment.
 
+### Example Configuration File
+
+An example configuration file for using this Checker Bundle within the ASAM Quality Checker Framework is as follows.
+
+```xml
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<Config>
+
+    <Param name="InputFile" value="test.xodr" />
+
+    <CheckerBundle application="xodrBundle">
+        <Param name="resultFile" value="xodr_bundle_report.xqar" />
+        <Checker checkerId="semantic_xodr" maxLevel="1" minLevel="3" />
+        <Checker checkerId="geometry_xodr" maxLevel="1" minLevel="3" />
+        <Checker checkerId="performance_xodr" maxLevel="1" minLevel="3" />
+    </CheckerBundle>
+
+    <ReportModule application="TextReport">
+        <Param name="strInputFile" value="Result.xqar" />
+        <Param name="strReportFile" value="Report.txt" />
+    </ReportModule>
+
+</Config>
+```
+
 ## Tests
 
 To run the tests, you need to install the extra test dependency.