Skip to content

Commit bef050c

Browse files
committed
Modified README
1 parent 25e0619 commit bef050c

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,6 @@
201201
limitations under the License.
202202

203203
Technische Universiteit Delft hereby disclaims all copyright interest
204-
in the software of "MIRTE robot" (en educational robot) written by the
204+
in the software of "MIRTE robot" (an educational robot) written by the
205205
Author(s).
206206
prof. dr. ir. Fred van Keulen, Dean of Mechanical Engineering

README.md

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

6-
# Test code style
7-
To cnotribute to this repository the code needs to pass the python
7+
## Install
8+
9+
```sh
10+
pip install .
11+
```
12+
13+
## Checks
14+
15+
To contribute to this repository the code needs to pass the python
816
[style check](https://github.com/mirte-robot/mirte-python/blob/develop/.github/workflows/python-check.yml)
917

1018
To check this locally before you commit/push:
@@ -14,3 +22,4 @@ black --check .
1422
# Fix by using:
1523
black .
1624
```
25+

0 commit comments

Comments
 (0)