diff README.md @ 349:76aa1486124a

Add some info about running tests in the readme
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 26 Sep 2020 15:36:25 +0200
parents 01b851161018
children 48a61e085e60
line wrap: on
line diff
--- a/README.md	Sat Sep 26 15:22:13 2020 +0200
+++ b/README.md	Sat Sep 26 15:36:25 2020 +0200
@@ -1,1 +1,15 @@
 # Sbplib
+
+## Running tests
+To run all tests simply run
+```
+(@v1.5) pkg> activate .
+(Sbplib) pkg> test
+```
+
+If you want to run tests from a specific file in `test/`, you can do
+```
+julia> using Pkg
+julia> Pkg.test(test_args=["testLazyTensors"])
+```
+This works by using the `@includetests` macro from the [TestSetExtensions](https://github.com/ssfrr/TestSetExtensions.jl) package. For more information, see their documentation.