From f671b406f2dcd516f8fadeb888407b51db696321 Mon Sep 17 00:00:00 2001 From: Christian Fredrik Johnsen Date: Wed, 8 May 2024 23:55:39 +0200 Subject: [PATCH] docs: add instructions on running tests --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2f6389a..46ce6f1 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,6 @@

-
Table of Contents
    @@ -29,6 +28,7 @@
  1. @@ -38,7 +38,7 @@
  2. Examples of usage
  3. -
  4. Team
  5. +
  6. Team
  7. License
@@ -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