From c01146205d98ca66163381a332ceb83cb69c5542 Mon Sep 17 00:00:00 2001 From: Tayfun Bocek Date: Wed, 13 Mar 2024 03:59:42 +0300 Subject: [PATCH] Cleanup --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0e97340..415fd84 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ have priority in testing and ease of use as that is what I can test for. ### Online Version: -You can read the online version of the documentation [here](https://vshieldpy.readthedocs.io/en/latest/). +You can read the online version of the documentation [here](https://vshieldpy.readthedocs.io/en/latest/). You can also download the offline version from the documentation page if preferred. ### Building it yourself: @@ -66,8 +66,8 @@ This will install the dev dependencies needed for testing, linting, and formatti For formatting and linting [ruff](https://github.com/astral-sh/ruff) is used. -You can run `python -m ruff check`, and `python -m ruff format` in the project directory before creating a PR to check if there is any issues. +You can run `python -m ruff check`, and `python -m ruff format` in the project to check if there is any issues. For testing [pytest](https://github.com/pytest-dev/pytest) is used. -Once that is complete, you can simply run `python -m pytest` in the project directory to start the tests. \ No newline at end of file +You can simply run `python -m pytest` in the project directory to start the tests.