Skip to content

Commit

Permalink
docs: add instructions on running tests
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristianFredrikJohnsen committed May 8, 2024
1 parent fc9e8c9 commit f671b40
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

</p>


<details>
<summary>Table of Contents</summary>
<ol>
Expand All @@ -29,6 +28,7 @@
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#running-tests">Running Tests</a></li>
</ul>
</li>
<li>
Expand All @@ -38,7 +38,7 @@
<li><a href="#examples-of-usage">Examples of usage</a></li>
</ul>
</li>
<li><a href="#team">Team</a></li>
<li><a href="#team">Team</a></li>
<li><a href="#license">License</a></li>
</ol>
</details>
Expand Down Expand Up @@ -81,6 +81,20 @@ Before you begin, ensure that your system meets the following requirements:
pip install -r requirements.txt
```

### Running Tests

To ensure that the project is set up correctly and functioning as expected, run the tests using the following command:

```bash
pytest
```

If you want to add print statements to the tests to debug, write your code of choice and run the following command:

```bash
pytest -s
```

## Usage

### Running main with Command Line Flags
Expand Down

0 comments on commit f671b40

Please sign in to comment.