From 536516d0f725811a3c70bc2c8b92ca4458610425 Mon Sep 17 00:00:00 2001
From: Jakub Stawowy <jakub.stawowy@testrevolution.io>
Date: Wed, 30 Nov 2022 22:09:41 +0100
Subject: [PATCH] add info about junit xml report

---
 readme.md => README.md | 7 +++++++
 1 file changed, 7 insertions(+)
 rename readme.md => README.md (95%)

diff --git a/readme.md b/README.md
similarity index 95%
rename from readme.md
rename to README.md
index 44f8995..c4f5759 100644
--- a/readme.md
+++ b/README.md
@@ -34,6 +34,13 @@ Your project will be executed with following command:
 pip install -e . && python3 setup.py pytest
 ```
 
+When configuring your setup.cfg ensure that the junit `tests.xml` report generation is enabled.
+These two options should be present:
+```ini
+addopts=--junitxml=tests.xml
+junit_family=legacy
+```
+
 Check out our [setup.py](setup.py) and [setup.cfg](setup.cfg) files.
 
 ## Automatic assessment