From 36d285f351548312e83d1fd611d2556b7b8ae1d0 Mon Sep 17 00:00:00 2001 From: dm1sh Date: Mon, 15 Feb 2021 15:02:47 +0500 Subject: [PATCH] Improved README.md documentation --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index dadf814..5e203e4 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,27 @@ run_tests(); ... ``` + +# Currently builtin matchers + +You can use the following functions or just pass boolean value as first argument of `test()` + +* `int is_equal(void *res, void *correct);` +* `int is_true(void *res);` +* `int is_false(void *res);` + +# Installation: + +```bash +make clean +make CT_VERSION=1 +sudo make install CT_VERSION=1 +``` + +# Uninstall: + +It is also required for update + +```bash +sudo make uninstall CT_VERSION=1 +```