From 8f6759bfa0cfcfaf379d09c0c331aabb7395d319 Mon Sep 17 00:00:00 2001
From: Federico Igne <git@federicoigne.com>
Date: Mon, 4 Oct 2021 09:54:55 +0100
Subject: Tag some tests as slow

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 6fcd98d..e61e889 100644
--- a/README.md
+++ b/README.md
@@ -118,11 +118,32 @@ java -cp <path/to/JRDFox.jar>:<path/to/fat.jar> uk.ac.ox.cs.rsacomb.RSAComb [<op
 
 ### Running tests
 
-To run the suit of unit test provided along with the code run
+To run the suites of tests provided along with the code run
 ```
 sbt test
 ```
 
+This will run all [unit tests](https://en.wikipedia.org/wiki/Unit_testing) and [functional tests](https://en.wikipedia.org/wiki/Functional_testing).
+If you want to limit the scope of the tests and run only a particular suite use
+```
+sbt "testOnly <test-class>"
+```
+
+For example, to execute only unit tests concerning the canonical model computation, run
+```
+sbt "testOnly uk.ac.ox.cs.rsacomb.CanonicalModelSpec"
+```
+
+or alternatively
+```
+sbt "testOnly *CanonicalModelSpec"
+```
+
+To run only functional tests for LUBM, excluding tests tagged as *slow* (that require more resources), run
+```
+sbt "testOnly *functional.LUBM -- -l org.scalatest.tags.Slow"
+```
+
 ## Changes introduced
 
 We tried to implement the system as close as possible to the theoretical description provided in [[1](#references)].
-- 
cgit v1.2.3