Skip to content

Commit 3e270d5

Browse files
committed
feature/doc: add appveyor status badge to README
1 parent 1cddef0 commit 3e270d5

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.org renamed to README.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
#+OPTIONS: ^:nil
2-
[[https://travis-ci.org/Dushistov/qt_monkey][https://travis-ci.org/Dushistov/qt_monkey.svg?branch=master]]
3-
[[https://github.com/Dushistov/qt_monkey/blob/master/LICENSE][https://img.shields.io/badge/license-BSD-green.svg]]
1+
# Qt Monkey [![Travis build status](https://travis-ci.org/Dushistov/qt_monkey.svg?branch=master)](https://travis-ci.org/Dushistov/qt_monkey) [![Appveyor build status](https://ci.appveyor.com/api/projects/status/c6h10uayiqmnr465?svg=true)](https://ci.appveyor.com/project/Dushistov/qt-monkey) [![License](https://img.shields.io/badge/license-BSD-green.svg)](https://github.com/Dushistov/qt_monkey/blob/master/LICENSE)
2+
3+
## Introduction
44

5-
* Introduction
65
Qt Monkey is a tool to automate testing of Qt-based applications (widgets only).
76
It automates creation/modification and running of the tests.
87
Tests are written in Javascript (Qt supported dialect).
@@ -11,40 +10,39 @@ To write your tests, simply run your application (instrumented by Qt Monkey) and
1110
on widget, input text, etc. As a result, a script in Javascript will be generated
1211
(see https://github.com/Dushistov/qt_monkey/blob/master/tests/test1.js for example).
1312

14-
#+OPTIONS: ^:nil
15-
[[example of script][https://github.com/Dushistov/qt_monkey/blob/master/docs/qtmonkey_gui.png]]
13+
[![example of script](https://github.com/Dushistov/qt_monkey/blob/master/docs/qtmonkey_gui.png)]
1614

1715
After that you can add suitable asserts and run this script via command line or GUI tool.
1816

19-
#+OPTIONS: ^:nil
20-
[[example of work of runnig script][https://github.com/Dushistov/qt_monkey/blob/master/docs/script_run_demo.gif]]
17+
[![example of work of runnig script](https://github.com/Dushistov/qt_monkey/blob/master/docs/script_run_demo.gif)]
18+
19+
## Requirements
2120

22-
* Requirements
2321
Qt Monkey requires compiler with C++11 support and Qt 4.x or Qt 5.x.
2422

25-
* How to use
23+
## How to use
24+
2625
First, download and build Qt Monkey:
27-
#+BEGIN_SRC sh
26+
```sh
2827
git clone --recursive https://github.com/Dushistov/qt_monkey.git
2928
cd qt_monkey
3029
cmake -DQT_VARIANT="qt5" .
3130
cmake --build .
32-
#+END_SRC
31+
```
3332

3433
Also you can use -DQT_VARIANT="qt4" for building with Qt 4.x.
3534
Then, integrate Qt Monkey agent into your application:
3635
1. Make sure that you link your application with qtmonkey_agent library
37-
3836
2. Create object of class `qt_monkey_agent::Agent` in the main thread of your application:
39-
#+BEGIN_SRC c++
37+
```C++
4038
qt_monkey_agent::Agent agent;
41-
#+END_SRC
39+
```
4240

4341
That's all. Now you can run qtmonkey_gui application
4442
and record or run your own scripts. See https://github.com/Dushistov/qt_monkey/blob/master/tests/test_app/main.cpp
4543
for the more complex usage example.
4644

47-
* Internals
45+
## Internals
4846

4947
Qt Monkey consists of three parts: Qt Monkey's agent library (qtmonkey_agent),
5048
qtmonkey_app (tool that run test application and cooperates with agent) and qtmonkey_gui.

0 commit comments

Comments
 (0)