Commit 9a87aac9 authored by Johannes Bechberger's avatar Johannes Bechberger

Improve README

parent 11722f1f
...@@ -54,7 +54,7 @@ Just clone `mjtest` and install it via `pip3`. ...@@ -54,7 +54,7 @@ Just clone `mjtest` and install it via `pip3`.
```sh ```sh
git clone https://github.com/mj3-16/mjtest git clone https://github.com/mj3-16/mjtest
cd mjtest cd mjtest
sudo pip3 install . sudo pip3 -e install .
``` ```
### Usage ### Usage
...@@ -97,6 +97,10 @@ This will… ...@@ -97,6 +97,10 @@ This will…
- … create reports in a folder named after the current date and time inside the `reports` folder - … create reports in a folder named after the current date and time inside the `reports` folder
- … output something like - … output something like
``` ```
[FAIL ] syntax:test.invalid the error output doesn't contain the word "error"
----------------------------------------
Ran 1 tests, of which 1 failed.
A full report for each test can be found at mjtest/reports/30.10.16:08:05:10.failed
``` ```
- … log that some test cases were executed correctly - … log that some test cases were executed correctly
- … return with an error code of `0` if all tests executed correct - … return with an error code of `0` if all tests executed correct
......
...@@ -26,7 +26,6 @@ setup(name='mjtest', ...@@ -26,7 +26,6 @@ setup(name='mjtest',
mjtest=mjtest.cli mjtest=mjtest.cli
''', ''',
install_requires=[ install_requires=[
'click',
'termcolor', 'termcolor',
'rainbow_logging_handler' 'rainbow_logging_handler'
] ]
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment