Skip to content

Commit 2985e65

Browse files
committed
Readme changes
1 parent bab89d6 commit 2985e65

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,21 @@
99
[![Coveralls Coverage Status](https://coveralls.io/repos/xmlrunner/unittest-xml-reporting/badge.svg?branch=master&service=github)](https://coveralls.io/github/xmlrunner/unittest-xml-reporting?branch=master)
1010
[![Requirements Status](https://requires.io/github/xmlrunner/unittest-xml-reporting/requirements.svg?branch=master)](https://requires.io/github/xmlrunner/unittest-xml-reporting/requirements/?branch=master)
1111

12-
# unittest-xml-reporting
12+
# unittest-xml-reporting (aka xmlrunner)
1313

14-
unittest-xml-reporting is a unittest test runner that can save test results
15-
to XML files that can be consumed by a wide range of tools, such as build
16-
systems, IDEs and continuous integration servers.
14+
A unittest test runner that can save test results to XML files in xUnit format.
15+
The files can be consumed by a wide range of tools, such as build systems, IDEs
16+
and continuous integration servers.
17+
18+
## Schema
19+
20+
There are many schemas with minor differences.
21+
We use one that is compatible with Jenkins xUnit plugin, a copy is
22+
available under `tests/vendor/jenkins/xunit-plugin/junit-10.xsd` (see attached license).
23+
You may also find these resources useful:
24+
25+
- https://stackoverflow.com/questions/4922867/what-is-the-junit-xml-format-specification-that-hudson-supports
26+
- https://stackoverflow.com/questions/11241781/python-unittests-in-jenkins
1727

1828
## Requirements
1929

@@ -136,7 +146,7 @@ if __name__ == "__main__":
136146
xmlrunner.XMLTestRunner().run(suite)
137147
````
138148

139-
### Django
149+
### Django support
140150

141151
In order to plug `XMLTestRunner` to a Django project, add the following
142152
to your `settings.py`:

0 commit comments

Comments
 (0)