[sr-dev] git:master: test/unit: README updated with more details about running unit tests

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: fad3b2482f98888351f4133f47a433b5bb36c3b7
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=fad3b2482f98888351f4133f47a433b5bb36c3b7

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Tue Sep 30 17:37:50 2014 +0200

test/unit: README updated with more details about running unit tests

---

 test/unit/README |   19 +++++++++++++++++++
 1 files changed, 19 insertions(+), 0 deletions(-)

diff --git a/test/unit/README b/test/unit/README
index d6735f4..85c5776 100644
--- a/test/unit/README
+++ b/test/unit/README
@@ -1,7 +1,11 @@
+Kamailio Test Unit
+==================
+
 This directory contains some small "smoke tests", that should assure that
 basic functionality of the server work as required. This tests should consists
 of one shell script and a config file if needed. They should not need much time
 for execution, to allow the run of the complete test suite in a few seconds.
+
 All test scripts must be self-contained, should not have external dependencies
 and must clean up after they are run. The second line in each scripts should
 contain a small comment that describe the task of the test, it should not
@@ -10,3 +14,18 @@ output any messages on successful runs.
 This tests should (in the current state) only run by developers who know
 what they do. They could delete your database, produce core dumps that fill
 your harddisk or do other nasty things..
+
+Usage
+-----
+
+To execute all unit tests, run:
+
+    make all
+
+To run a specific unit test, run:
+
+    make run UNIT=scripname
+
+Scriptname is the name of shell file to execute, for example:
+
+    make run UNIT=1.sh