Skip to content

Commit 8630999

Browse files
committed
docs: quick fix for readme
1 parent 59f5f04 commit 8630999

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -141,13 +141,19 @@ Please see the [Contribution Guidelines](https://github.com/LetMeR00t/pyCheckpoi
141141

142142
Once Poetry is installed, you can create and validate your development environment using those commands:
143143

144-
$ poetry install
145-
...
146-
$ poetry build
147-
...
148-
$ poetry shell
149-
...
150-
$ pytest
144+
```sh
145+
poetry install
146+
# this is installing the package using poetry
147+
148+
poetry build
149+
# this is building the package locally (not required)
150+
151+
poetry shell
152+
# this is usind the dedicated virtual environment for development
153+
154+
$ pytest
155+
# Run the tests
156+
```
151157

152158
You should then see the output of pytest results with all tests passed.
153159

0 commit comments

Comments
 (0)