We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent f8b8149 commit 25e0619Copy full SHA for 25e0619
1 file changed
README.md
@@ -1,12 +1,16 @@
1
# MIRTE Python API
2
-This package provides the API for the MIRTE Robot. Please
3
-read the MIRTE documentation.
+This package provides the API for the [MIRTE robot](https://mirte.org).
+Please read the [MIRTE documentation](https://docs.mirte.org/develop/doc/api/mirte_python_api.html)
4
+for further documentation of this API.
5
6
# Test code style
-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:
11
```sh
12
pip install black
13
black --check .
-# Fix by using
14
+# Fix by using:
15
black .
16
```
0 commit comments