Merge lp:~javier.collado/content-hub/bug1274899 into lp:content-hub

[Javier Collado]

Added README file

This branch adds a README file to the branch with the basic information about
he project.

[lp:~javier.collado/content-hub/bug1274899]

73. By Javier Collado on 2014-01-31

Fixed typo

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:72
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~javier.collado/content-hub/bug1274899/+merge/204208/+edit-commit-message

http://jenkins.qa.ubuntu.com/job/content-hub-ci/105/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-amd64-ci/8
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-armhf-ci/8
        deb: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-armhf-ci/8/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-i386-ci/8

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/content-hub-ci/105/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:73
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~javier.collado/content-hub/bug1274899/+merge/204208/+edit-commit-message

http://jenkins.qa.ubuntu.com/job/content-hub-ci/106/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-amd64-ci/9
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-armhf-ci/9
        deb: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-armhf-ci/9/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-i386-ci/9

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/content-hub-ci/106/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:73
http://jenkins.qa.ubuntu.com/job/content-hub-ci/108/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-amd64-ci/11
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-armhf-ci/11
        deb: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-armhf-ci/11/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-i386-ci/11

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/content-hub-ci/108/rebuild

review: Approve (continuous-integration)

[Ken VanDine (ken-vandine)]

A couple minor changes.

It would be better to build out of tree

mkdir build
cd build
cmake ..
make

Also for running the tests, I'd recommend running them with dbus-test-runner so they don't interfere with the users dbus session.

cd build/tests
dbus-test-runner -t make -p test

review: Needs Fixing

[lp:~javier.collado/content-hub/bug1274899]

74. By Javier Collado on 2014-02-12

Added suggestions from Ken

[Javier Collado (javier.collado)]

The last change should address all your suggestions. Please let me know if
that's not the case.

review: Needs Resubmitting

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:74
http://jenkins.qa.ubuntu.com/job/content-hub-ci/110/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-amd64-ci/13
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-armhf-ci/13
        deb: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-armhf-ci/13/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/content-hub-trusty-i386-ci/13

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/content-hub-ci/110/rebuild

review: Approve (continuous-integration)

[Leo Arias (elopio)]

I followed the steps, everything works as expected. Thanks Javier.

review: Approve

[Ken VanDine (ken-vandine)]

Excellent, thanks!

review: Approve

[Javier Collado (javier.collado)]

Ken, should this get merged automatically? If that's not the case, then please
apply the merge since I don't have permissions to push to lp:content-hub.
Thanks.

[Ken VanDine (ken-vandine)]

Did you perform an exploratory manual test run of the code change and any related functionality on device or emulator?

 * No code change, just added a README file.

Did CI run pass? If not, please explain why.

 * Yes

Have you checked that submitter has accurately filled out the submitter checklist and has taken no shortcut?

 * The checklist wasn't filled out, this branch was approved before we changed the landing process. I have ensured all the steps were successful.

review: Approve

=== added file 'README'
--- README	1970-01-01 00:00:00 +0000
+++ README	2014-02-12 16:53:02 +0000
@@ -0,0 +1,52 @@
+What is content-hub?
+--------------------
+
+content-hub is a mediation service to let applications share content between
+them even if they are not running at the same time.
+
+For a more detailed description, please have a look at:
+doc/Mainpage.md
+
+
+How do I get all building dependencies?
+---------------------------------------
+
+Build dependencies are already listed in the debian/control file. To get them
+use the following command:
+sudo apt-get build-dep content-hub
+
+
+How do I compile the code?
+--------------------------
+
+To compile the code run the following command from the branch directory:
+mkdir build
+cd build
+cmake ..
+make
+
+
+How do I run the test cases?
+----------------------------
+
+To run the test cases use the following command:
+cd build/tests
+dbus-test-runner -t make -p test
+
+
+How do I build the packages?
+----------------------------
+
+To build the pacakges run the following command:
+bzr builddeb
+
+
+How do I install the code?
+--------------------------
+
+One way to do it one the code is compiled is:
+make install
+
+However, the recommended way to do it is by installing the packages built
+manually.
+