Skip to content

Commit

Permalink
README.md updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Dariush Hasapour committed Apr 6, 2020
1 parent 4d0f28f commit f458c85
Showing 1 changed file with 51 additions and 7 deletions.
58 changes: 51 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,66 @@ Lizard

A lightweight and efficient C++ testing package.

Demo
---
![lizard C++ testing package demo](demo.gif)


```bash
git clone https://github.com/alphamarket/lizard.git
cd lizard
mkdir build && cd build
cmake .. && make
./test
```

```c++
// lizard/tests/sample_tester.hpp
#ifndef SAMPLE_TESTER_HPP
#define SAMPLE_TESTER_HPP

#include "lizard/lizard.hpp"

TESTER(sample_tester,

spec(sum, []() {
IS_EQUAL(1 + 2, 3);
});

spec(multiply, []() {
SKIP_WITH_MESSAGE("SKIP WITH MESSAGE");
});

spec(minus, []() {
IS_EQUAL(1 - 2, -1);
});

spec(faulty, []() {
IS_EQUAL(2 / 2, -1);
});

spec(divide, []() {
IS_EQUAL(2 / 2, 1);
});
)

#endif
```


Prerequisites
---
No prerequisites is needed. The project is as is.

How to step up?
How to step up in your project?
-----
Assume you have a project named `cppApp` written in C++.

There is a [setup script](https://raw.githubusercontent.com/noise2/lizard/master/lizard-setup) provided to make cloning this C++ Tester repository into your project easier
There is a [setup script](https://raw.githubusercontent.com/alphamarket/lizard/master/lizard-setup) provided to make cloning this C++ Tester repository into your project easier

```BASH
cd "/path/to/cppApp"
curl https://raw.githubusercontent.com/noise2/lizard/master/lizard-setup | bash
curl https://raw.githubusercontent.com/alphamarket/lizard/master/lizard-setup | bash
# That is it.
cd test
```

Demo
---
For demo download/clone [this](https://github.com/noise2/lizard-demo).

0 comments on commit f458c85

Please sign in to comment.