Merge lp:~alecu/unity-scope-click/add-readmes into lp:unity-scope-click/devel

[Alejandro J. Cura]

Add README and HACKING files

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:259
http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-ci/61/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-amd64-ci/36
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-armhf-ci/35
        deb: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-armhf-ci/35/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-i386-ci/35

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-team-unity-scope-click-devel-ci/61/rebuild

review: Approve (continuous-integration)

[dobey (dobey)]

Is there any particularly good reason to reproduce the short version of the license, and the Copyright info, in the README? I think we shouldn't be putting that here, as the COPYING and source files describe the license and any copyright well enough already.

review: Needs Information

[Leo Arias (elopio)]

I tried all the steps and they work, so +1 for my side. I don't have a strong opinion on the License section of the README. I kind of like it, but I couldn't give good reasons to dobey.

review: Approve

[Leo Arias (elopio)]

Please add the steps to generate the coverage report.

install gcovr and lcov
cmake .. -DCMAKE_BUILD_TYPE=coverage
make coverage-html

The html will be left on the coveragereport directory.

[Leo Arias (elopio)]

review: Needs Fixing

[Alejandro J. Cura (alecu)]

I used Mir's README and HACKING files as a base, that's where I took the license paragraphs:
http://bazaar.launchpad.net/~mir-team/mir/utopic/view/head:/README.md

[lp:~alecu/unity-scope-click/add-readmes]

260. By Alejandro J. Cura on 2014-05-16

Fix copyright line, add info on how to run coverage testing.

261. By Alejandro J. Cura on 2014-05-16

Remove License from README, added paragraph that points to other files

[dobey (dobey)]

review: Approve

[Leo Arias (elopio)]

review: Approve

=== added file 'HACKING'
--- HACKING	1970-01-01 00:00:00 +0000
+++ HACKING	2014-05-16 18:54:57 +0000
@@ -0,0 +1,61 @@
+unity-scope-click hacking guide
+===============================
+
+Getting unity-scope-click
+-------------------------
+
+To get the main development branch of unity-scope-click:
+
+    $ bzr branch lp:unity-scope-click/devel
+
+
+Getting dependencies
+--------------------
+
+To succesfully build the scope there are a few packages required:
+
+    $ sudo apt-get build-dep unity-scope-click
+
+
+Building the scope
+------------------
+
+This scope is built using cmake. Here's an example on how to build it:
+
+    $ mkdir build
+    $ cd build
+    $ cmake ..
+    $ make -j 8
+
+
+Running the unit tests
+----------------------
+
+    $ make check
+
+Or, if you want to run the tests under valgrind:
+
+    $ make check-valgrind
+
+
+Running the scope
+-----------------
+
+You will usually run the scope inside a unity8 session, but when developing
+a good way to test it is with unity-scope-tool. Inside the build directory do:
+
+    $ mkdir clickscope
+    $ (cd clickscope;ln -s ../scope/click/libclickscope.so .; ln -s ../data/clickscope.ini .)
+    $ U1_DEBUG=true unity-scope-tool clickscope/clickscope.ini
+
+
+Running the coverage tests
+--------------------------
+
+To run the coverage tests you'll need to install the gcovr and lcov packages.
+Then you need to compile with coverage enabled, like this:
+
+    $ cmake .. -DCMAKE_BUILD_TYPE=coverage
+    $ make coverage-html
+
+The html will be left on the coveragereport directory.

=== modified file 'README'
--- README	2013-07-18 18:25:34 +0000
+++ README	2014-05-16 18:54:57 +0000
@@ -0,0 +1,16 @@
+Readme
+======
+
+unity-scope-click - Click Packages Scope for Unity
+--------------------------------------------------
+
+This scope shows the list of installed applications, and the list of 
+applications available to download from the appstore webservice.
+To authenticate downloads, this scope uses Ubuntu Online Accounts to
+get credentials for the logged in user.
+Since scopes are short lived, ubuntu-download-manager is used to do
+the actual download.
+
+You can find information on how to compile and run this program in 
+the HACKING file, and you can find licensing information in the 
+COPYING file.