From 72db7011f71961ddec8c9f8176bfc63f4a93bf67 Mon Sep 17 00:00:00 2001 From: Michał Łyszczek Date: Wed, 17 Jan 2018 19:33:32 +0100 Subject: updated readme --- readme.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index e30a94e..9f92336 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,6 @@ +[kursg-meta]: # (title: about) +[kursg-meta]: # (order: 1) + About ===== @@ -22,6 +25,14 @@ usually not necessary. The good thing of calling **make install** is that, man pages will be installed in your system, so you can have quick overview of the library if you forget anything. +Documentation +============= + +Full documentation (and some more info) is available at +[mtest.kurwinet.pl](http://mtest.kurwinet.pl/manuals/man3.html) + +There are also man pages in **man** directory. + Why === @@ -33,9 +44,15 @@ it's a proof that unit testing can be very easy to implement. Examples ======== -Example test is in *example* directory, also memperf -(https://github.com/mlyszczek/memperf) makes use of this framework for its -tests. Tests results are integrated with automake **make check** call. +Example test is in [example](http://git.kurwinet.pl/mtest/tree/example) +directory. Also following projects use **mtest** for testing: + +* [memperf](http://git.kurwinet.pl/memperf) +* [embedlog](http://git.kurwinet.pl/embedlog) +* [kurload](http://git.kurwinet.pl/kurload) +* [librb](http://git.kurwinet.pl/librb) + +Tests results are integrated with automake **make check** call. License ======= @@ -46,3 +63,10 @@ Authors ======= Michał Łyszczek + +See also +======== + +* [project webpage](http://mtest.kurwinet.pl) +* [git repository](http://git.kurwinet.pl/mtest) +* [test anything protocol (tap)](http://testanything.org) -- cgit v1.2.3-8-gadcc