Merge lp:~ahayzen/qtubuntu-print/add-readme into lp:qtubuntu-print

[Andrew Hayzen]

* Add a readme

* Add a readme

[Michael Sheldon (michael-sheldon)]

Couple of small suggestions included as diff comments

[lp:~ahayzen/qtubuntu-print/add-readme]

30. By Andrew Hayzen on 2017-02-20

* Change build example to be an out-of-tree build
* Fix comments for grammar errors

[Andrew Hayzen (ahayzen)]

1) Should this say "sends it over content-hub"?

Yep, fixed it :-)

2) Might be better to give an example of an out of tree build as these are normally preferred

Good idea, fixed.

I also noticed "simple invoke cmake" should have been "simply invoke cmake".

Thanks, please re-review :-)

[lp:~ahayzen/qtubuntu-print/add-readme]

31. By Andrew Hayzen on 2017-02-20

* Pull of upstream fix for missing depends

32. By Andrew Hayzen on 2017-02-21

* Pull of upstream removal of qt5-default and using -qt=qt5

33. By Andrew Hayzen on 2017-02-21

* Pull of upstream

34. By Andrew Hayzen on 2017-02-21

* Fix for typo

[Michael Sheldon (michael-sheldon)]

Looks good, approved :)

review: Approve

=== added file 'README.md'
--- README.md	1970-01-01 00:00:00 +0000
+++ README.md	2017-02-21 14:38:41 +0000
@@ -0,0 +1,54 @@
+qtubuntu-print is a plugin to the printing system of Qt.
+It generates a PDF document and sends it over content-hub
+to a destination application.
+
+# Building
+
+The build system uses cmake.
+To compile, simply invoke cmake and then make:
+
+```
+mkdir build
+cd build
+cmake ../
+make
+```
+
+# Building a deb
+
+To build a deb package, invoke bzr builddeb:
+
+```
+bzr builddeb
+```
+
+# Installing
+
+To install the plugin on the system, invoke make install:
+
+```
+sudo make install
+```
+
+# Running
+
+qtubuntu-print is a plugin to the printing system of Qt.
+To use qtubuntu-print with an application such as kate invoke the following:
+
+```
+QT_PRINTER_MODULE=qtubuntu-print kate
+```
+
+# Unit tests
+
+To run the unit tests, you can use the commands below:
+
+```
+make test
+```
+
+or
+
+```
+ctest
+```