Skip to content

Commit 9fdf201

Browse files
author
Andrii Boichuk
committed
Add Readme.md file
1 parent 7509e9a commit 9fdf201

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

Readme.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Synopsis
2+
QtWebDriver(QtWD) is library based on Google ChromeDriver and intended for automatic testing. At the momemnt, you can use it to test many kinds of Qt application - QWidget, QwebView and QQuick1(Qt4) or QQuick2(Qt5) based applications. If you hadn't used selenium for automatic testing, you may also find this links helpfull:
3+
http://code.google.com/p/selenium/w/list
4+
http://docs.seleniumhq.org/
5+
# Code Example
6+
See out test application in src/Test/main.cc
7+
8+
# Build and run
9+
To build WD you need:
10+
* Install Qt (4 or 5)
11+
* Create wd.gypi file, our current wd.gypi looks like: ```
12+
{
13+
'variables': {
14+
'QT5': '0', # change to '1' for enabling Qt5
15+
'QT_BIN_PATH': '/home/username/Qt5.2.1/5.2.1/gcc/bin/',
16+
'QT_INC_PATH': '/home/username/Qt5.2.1/5.2.1/gcc/include/',
17+
'QT_LIB_PATH': '/home/username/Qt5.2.1/5.2.1/gcc/lib/',
18+
},
19+
}
20+
21+
```
22+
# API Reference
23+
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
24+
# Tests
25+
Describe and show how to run the tests with code examples.
26+
# Contributors
27+
Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
28+
# License
29+
Classic LGPL License. This means that you can’t ship this your product with QtWD unlees it’s an LGPL product, but you can free test it in your local enviroment and just doesn’t ship
30+

0 commit comments

Comments
 (0)