Skip to content
This repository was archived by the owner on Jan 23, 2025. It is now read-only.

Commit 28b8258

Browse files
committed
readme - readability refinements
1 parent fdb720b commit 28b8258

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ Example: The video is called `video.mpg`, the metadata file shall be named `vide
1818

1919
## How to use the code
2020

21-
Here's an example piece of code. Other examples can be found in the unit test classes.
22-
* see also [search_check.py](doc/search_check.py)
21+
Here's an example piece of code. Other examples can be found in the unit test classes. Please refer also to [search_check.py](doc/search_check.py).
2322

2423
```python:
2524
@@ -115,18 +114,19 @@ Here are the screenshots of the supported media types in German English (I did n
115114
You're welcome to contribute, but please be aware of ...
116115

117116
* You should provide a unit test for your changes with a good coverage. To do this, install ``nose2`` and ``coverage`` and execute the tests with:
118-
```sh
119-
$ python -m venv venv
120-
$ source venv/bin/activate
121-
$ pip install nose2
122-
$ pip install coverage
123-
$ nose2 --verbose
124-
test_encodeTemplate2 (testvsmetaSeriesEncoder.TestVsMetaEncoder.test_encodeTemplate2) ... ok
125-
test_encodeTemplate3 (testvsmetaSeriesEncoder.TestVsMetaEncoder.test_encodeTemplate3) ... ok
126-
test_encodeTemplate4 (testvsmetaSeriesEncoder.TestVsMetaEncoder.test_encodeTemplate4) ... ok
127-
(...)
128-
```
129-
* I won't react immediately with checking your pull requests in.
117+
118+
```sh
119+
$ python -m venv venv
120+
$ source venv/bin/activate
121+
$ pip install nose2
122+
$ pip install coverage
123+
$ nose2 --verbose
124+
test_encodeTemplate2 (testvsmetaSeriesEncoder.TestVsMetaEncoder.test_encodeTemplate2) ... ok
125+
test_encodeTemplate3 (testvsmetaSeriesEncoder.TestVsMetaEncoder.test_encodeTemplate3) ... ok
126+
test_encodeTemplate4 (testvsmetaSeriesEncoder.TestVsMetaEncoder.test_encodeTemplate4) ... ok
127+
(...)
128+
```
129+
* I won't react immediately with checking your pull requests in, but will try to do it within some days.
130130
131131
# References
132132

0 commit comments

Comments
 (0)