Initial commit

1 files changed, 54 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..abbb405
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# Enginio Qt Library Tests 
+Set of automated tests for Enginio Qt client library. 
+
+
+# System Requirements
+* Qt 5.0 or newer
+* OpenSSL library. Windows installer: http://slproweb.com/products/Win32OpenSSL.html (light version is enough, copy DLLs to windows system directory when asked). In Linux seach for `libssl` in your distribution's package repository.
+
+
+# Get the code
+* Clone the repository
+* Test project includes Enginio client library as Git submodule under enginio-qt directory. After fresh clone submodule directories are empty. You must tell Git to fetch submodule code by giving following commands (in root directory enginio-qt-tests):
+  * `git submodule init`
+  * `git submodule update`
+* Please note that there's no need to install Enginio client library. Tests build and link to included library.
+
+
+# Running tests from Qt Creator
+* Open test project enginio-qt-tests.pro in Qt Creator
+* Run individual tests by right-clicking test sub-projects and selecting Run.
+
+
+# Running tests from command line (Linux only):
+* `cd enginio-qt-tests`
+* `qmake`
+* `make`
+* `./run-all-tests.sh`
+* If you run individual test executables from bin directory, library path must be specified. For example: `LD_LIBRARY_PATH=enginio-qt/enginio_client/ bin/tst_objectoperationtest`
+
+
+# Contributing
+* Fork the repository on [GitHub](https://github.com/enginio/enginio-qt-tests)
+* Create a [feature branch](http://nvie.com/posts/a-successful-git-branching-model/) (i.e. create a branch which is named like my-cool-feature)
+* Implement the new feature and automated tests for it
+* Make sure all tests pass
+* Submit a pull request that includes only your feature branch
+
+
+# Copyright
+Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+Contact http://qt.digia.com/contact-us 
+
+
+# License
+Enginio Qt library tests are tri-licensed under the Commercial Qt License, the GNU General Public License 3.0, and the GNU Lesser General Public License 2.1.
+
+**Commercial License Usage**
+Licensees holding valid Commercial Qt Licenses may use this test set in accordance with the commercial license agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Digia. For licensing terms and conditions see http://qt.digia.com/licensing. For further information use the contact form at http://qt.digia.com/contact-us.
+
+**GNU Lesser General Public License Usage**
+Alternatively, this test set may be used under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation and appearing in the file LICENSE.LGPL included in the packaging of this library. Please review the following information to ensure the GNU Lesser General Public License version 2.1 requirements will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. In addition, as a special exception, Digia gives you certain additional rights. These rights are described in the Digia Qt LGPL Exception version 1.1, included in the file LGPL_EXCEPTION.txt.
+
+**GNU General Public License Usage**
+Alternatively, this test set may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE.GPL included in the packaging of this library. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.