Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
robamu committed Jan 24, 2024
1 parent 94368b4 commit b034366
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,26 @@ py -m pip install spacepackets

You can find all examples [inside the documentation](https://spacepackets.readthedocs.io/en/latest/examples.html).


# Tests

All tests are provided in the `tests` folder and can be run with coverage information
by running
If you want to run the tests, it is recommended to install `pytest` and `coverage` (optional)
first. You also have to install the package with the optional `test` feature:

```sh
coverage run -m pytest
pip install coverage pytest
```

provided that `pytest` and `coverage` were installed with
Running tests regularly:

```sh
python3 -m pip install coverage pytest
pytest .
```

Running tests with coverage:

```sh
coverage run -m pytest
```

# Documentation
Expand Down

0 comments on commit b034366

Please sign in to comment.