From f0bc672b6056778e358c8f5844b093d2742d00ab Mon Sep 17 00:00:00 2001 From: Dominic Date: Mon, 19 Jul 2021 17:11:57 +0100 Subject: Update README.md tidy up testing section --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ad7aae51..2cd68d69 100644 --- a/README.md +++ b/README.md @@ -106,19 +106,20 @@ On *Windows*, make sure you have `git-daemon` in your PATH. For MINGW-git, the exists in `Git\mingw64\libexec\git-core\`; CYGWIN has no daemon, but should get along fine with MINGW's. -Ensure testing libraries are installed. In the root directory, run: `pip install test-requirements.txt` -Then, +Ensure testing libraries are installed. +In the root directory, run: `pip install -r test-requirements.txt` -To lint, run `flake8` -To typecheck, run `mypy -p git` -To test, `pytest` +To lint, run: `flake8` -Configuration for flake8 is in root/.flake8 file. -Configuration for mypy, pytest, coverage is in root/pyproject.toml. +To typecheck, run: `mypy -p git` -The same linting and testing will also be performed against different supported python versions -upon submitting a pull request (or on each push if you have a fork with a "main" branch). +To test, run: `pytest` + +Configuration for flake8 is in the root/.flake8 file. +Configurations for mypy, pytest and coverage.py are in root/pyproject.toml. +The same linting and testing will also be performed against different supported python versions +upon submitting a pull request (or on each push if you have a fork with a "main" branch and actions enabled). ### Contributions -- cgit v1.2.1 From 23066f6fe414ec809434727485136b7cd84aa5b8 Mon Sep 17 00:00:00 2001 From: Dominic Date: Mon, 19 Jul 2021 17:16:43 +0100 Subject: Update README.md Add paragraph space --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2cd68d69..5087dbcc 100644 --- a/README.md +++ b/README.md @@ -115,8 +115,9 @@ To typecheck, run: `mypy -p git` To test, run: `pytest` -Configuration for flake8 is in the root/.flake8 file. -Configurations for mypy, pytest and coverage.py are in root/pyproject.toml. +Configuration for flake8 is in the ./.flake8 file. + +Configurations for mypy, pytest and coverage.py are in ./pyproject.toml. The same linting and testing will also be performed against different supported python versions upon submitting a pull request (or on each push if you have a fork with a "main" branch and actions enabled). -- cgit v1.2.1