Skip to content

Commit 25e0619

Browse files
committed
Added links to readme
1 parent f8b8149 commit 25e0619

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
# MIRTE Python API
2-
This package provides the API for the MIRTE Robot. Please
3-
read the MIRTE documentation.
2+
This package provides the API for the [MIRTE robot](https://mirte.org).
3+
Please read the [MIRTE documentation](https://docs.mirte.org/develop/doc/api/mirte_python_api.html)
4+
for further documentation of this API.
45

56
# Test code style
6-
To check the Python code style run:
7+
To cnotribute to this repository the code needs to pass the python
8+
[style check](https://github.com/mirte-robot/mirte-python/blob/develop/.github/workflows/python-check.yml)
9+
10+
To check this locally before you commit/push:
711
```sh
812
pip install black
913
black --check .
10-
# Fix by using
14+
# Fix by using:
1115
black .
1216
```

0 commit comments

Comments
 (0)