From 47cc2b8aabebd377f40accb33a3812b64f203a26 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20Ber=C3=A1nek?= <berykubik@gmail.com>
Date: Wed, 22 Nov 2023 14:35:36 +0100
Subject: [PATCH] Add README to tests

---
 tests/README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/tests/README.md b/tests/README.md
index f5e0062e3..7bec07cea 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -1,4 +1,32 @@
-# Bless tests
+# HyperQueue test suite
+This directory contains the Python test suite of HyperQueue.
+
+## Usage
+The following commands are supposed to be executed from the root HyperQueue directory.
+
+1) Install `pytest` and other dependencies
+    ```bash
+    $ python -m pip install tests/requirements.txt
+    ```
+2) Run tests
+    ```bash
+    $ python -m pytest tests
+    ```
+
+You can speed up test execution by running them in parallel:
+```bash
+$ python -m pytest tests -n16
+```
+
+### Running autoalloc tests
+There are several tests for the automatic allocator that require the presence of an external service (PBS).
+If you are on a system that has these services installed, you can run these tests with the `pbs` mark:
+```bash
+$ python -m pytest tests -m pbs
+```
+
+## Blessing
+You can bless tests with the following command:
 ```bash
 $ python -m pytest --inline-snapshot=create
 ```