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

[Michael Sheldon]

Couple of small suggestions included as diff comments

Diff comments:

> === added file 'README.md'
> --- README.md	1970-01-01 00:00:00 +0000
> +++ README.md	2017-02-20 17:19:59 +0000
> @@ -0,0 +1,52 @@
> +qtubuntu-print is a plugin to the printing system of Qt.
> +It generates a PDF document and sends over content-hub

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

> +to a destination application.
> +
> +# Building
> +
> +The build system uses cmake.
> +To compile, simple invoke cmake and then make:
> +
> +```
> +cmake .

Might be better to give an example of an out of tree build as these are normally preferred. e.g.

mkdir build
cd build
cmake ../
make

> +make
> +```
> +
> +# Building a deb
> +
> +To build a deb package, invoke bzr builddeb:
> +
> +```
> +bzr builddeb
> +```
> +
> +# Installing
> +
> +To install the plugin on the system, invoke use 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
> +```


-- 
https://code.launchpad.net/~ahayzen/qtubuntu-print/add-readme/+merge/317790
Your team Ubuntu Phablet Team is requested to review the proposed merge of lp:~ahayzen/qtubuntu-print/add-readme into lp:qtubuntu-print.