Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nanthony21 committed Mar 3, 2022
1 parent 908323f commit 4422d8d
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ More information [here](https://docs.conda.io/projects/conda/en/latest/user-guid
## Building from source and distributing
For information on creating a Conda package yourself see [here](docs/building.md).

## Testing
Automated tests using the [pytest](https://docs.pytest.org/en/7.0.x/) framework reside under the [tests](tests) directory. The default configuration for pytest can be found in [pyproject.toml](https://github.com/BackmanLab/PWSpy/blob/dev/pyproject.toml). Pytest 6.0 or greater is required. For more information on running pytest from the commandline or IDE integration please see the pytest [documentation](https://docs.pytest.org/en/7.0.x/how-to/index.html#how-to). The tests require that you first install the test dataset under `tests/resources`. Due to the size of the test dataset it is hosted externally rather than being included in the Git repository. Please check [here](tests/resources/readme.txt) for up to date information on how to acquire the test dataset.

## Contributing
Read the [contributing section](CONTRIBUTING.md) in the documentation if you want to help us improve and further develop PWSpy!

0 comments on commit 4422d8d

Please sign in to comment.