Skip to content

Commit 9e8ca47

Browse files
added usage tips to README
1 parent dcfc22e commit 9e8ca47

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,29 @@ This repository provides a template for Python 3.12 projects based on [Poetry](h
77
* [mypy](https://mypy.readthedocs.io/en/stable) is used for type checking
88
* [pytest](https://docs.pytest.org/en/8.2.x) is used for writing tests
99
* [ruff](https://docs.astral.sh/ruff) is used for linting and formatting
10+
11+
## Usage
12+
13+
To setup the virtual environment and install your project, run:
14+
15+
```shell
16+
make install
17+
```
18+
19+
To use the linter and type checker, run:
20+
21+
```shell
22+
make lint
23+
```
24+
25+
To run the test suite:
26+
27+
```shell
28+
make test
29+
```
30+
31+
To lint, type check, and test in a single command, run:
32+
33+
```shell
34+
make check
35+
```

0 commit comments

Comments
 (0)