From 714d6e9e31417ae55fb508dbbd4d471a4c56ac63 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Blin?=
<sebastien.blin@savoirfairelinux.com>
Date: Fri, 20 Oct 2017 11:02:23 -0400
Subject: [PATCH] add build instructions for tests in README.md
Change-Id: I23bcb3c481d56e16373c2b4b017d94ca50293737
Reviewed-by: Guillaume Roguez <guillaume.roguez@savoirfairelinux.com>
---
INSTALL | 24 +++++++++++++++++++++++-
1 file changed, 23 insertions(+), 1 deletion(-)
diff --git a/INSTALL b/INSTALL
index 278f6148..098a4b01 100644
--- a/INSTALL
+++ b/INSTALL
@@ -23,7 +23,7 @@ To install the appplication, type the following commands in a console, while in
-DCMAKE_INSTALL_PREFIX=<install location>
-DCMAKE_BUILD_TYPE=<Debug to compile with debug symbols>
-DENABLE_VIDEO=<False to disable video support>
- make -j3
+ make -jx # where x is the number of core you have
make install
Explanation
@@ -65,6 +65,28 @@ make install
You can now link and build the OSX client with Ring daemon and LRC library
+Testing
+=======
+
+Tests are written in the `test` directory.
+To run tests, you need to rebuild the application with these commands (from the root directory of the project):
+
+ mkdir -p build-test
+ cd build-test
+ cmake .. -DENABLE_TEST=true
+ The following options are often usefull to append to the cmake line:
+ -DRING_BUILD_DIR=<daemon install location>
+ -DRING_XML_INTERFACES_DIR=<daemon dbus interface definitions directory>
+ -DCMAKE_INSTALL_PREFIX=<install location>
+ -DCMAKE_BUILD_TYPE=<Debug to compile with debug symbols>
+ -DENABLE_VIDEO=<False to disable video support>
+ make -jx # where x is the number of core you have
+ make test # or ./LRCTester for more verbosity.
+
+In the `test` directory you can also find a `mocks` folder used to simulate the ring daemon.
+`CppUnit` is the testing library used for this project.
+
+
Internationalization
====================
--
GitLab