Skip to content

Commit b47d829

Browse files
committed
Add README directions.
1 parent c55c034 commit b47d829

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,6 @@ venv.bak/
102102

103103
# mypy
104104
.mypy_cache/
105+
106+
# Vim
107+
*.sw*

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,28 @@ at Python Frederick.
88
Our goal was to show off pytest
99
and how to do automated testing
1010
in your projects.
11+
12+
## Getting started
13+
14+
Create a virtual environment to hold your local packages
15+
(i.e. `pytest`).
16+
17+
```bash
18+
$ python3 -m venv venv
19+
$ source venv/bin/activate
20+
```
21+
22+
Install `pytest` from PyPI.
23+
24+
```bash
25+
(venv) $ pip install pytest
26+
```
27+
28+
## Run the tests
29+
30+
You can run the tests for this project
31+
by running `pytest`.
32+
33+
```bash
34+
$ pytest
35+
```

0 commit comments

Comments
 (0)