Merge lp:~whosdaz/ubuntu-filemanager-app/gci6198315054006272 into lp:ubuntu-filemanager-app

Proposed by Matthew Allen on 2015-12-23
Status: Superseded
Proposed branch: lp:~whosdaz/ubuntu-filemanager-app/gci6198315054006272
Merge into: lp:ubuntu-filemanager-app
Diff against target: 447 lines (+237/-175)
4 files modified
README (+14/-169)
README.autopilot (+55/-0)
README.developers (+154/-0)
README.translations (+14/-6)
To merge this branch: bzr merge lp:~whosdaz/ubuntu-filemanager-app/gci6198315054006272
Reviewer Review Type Date Requested Status
Andrew Hayzen (community) Needs Fixing on 2015-12-23
Ubuntu File Manager Developers 2015-12-23 Pending
Review via email: mp+281280@code.launchpad.net

This proposal has been superseded by a proposal from 2015-12-23.

To post a comment you must log in.
Andrew Hayzen (ahayzen) wrote :

This looks good so far, however for the other READMEs we have opted to use the markdown format, so to remain consistent with the other coreapps could this be updated? Also the web links should be in the format [title](url), you can use the weather mp [0] for reference. Sorry this should have been mentioned in the code-in task, but it hadn't been updated.

0 - https://code.launchpad.net/~emailgirishrawat/ubuntu-weather-app/markdown-readmes/+merge/280787

review: Needs Fixing
513. By Matthew Allen on 2015-12-23

Fixed Markdown Syntax

514. By Matthew Allen on 2015-12-23

Changed file extensions to .md

515. By Matthew Allen on 2015-12-23

Fixed minor syntax issues

Unmerged revisions

515. By Matthew Allen on 2015-12-23

Fixed minor syntax issues

514. By Matthew Allen on 2015-12-23

Changed file extensions to .md

513. By Matthew Allen on 2015-12-23

Fixed Markdown Syntax

512. By Matthew Allen on 2015-12-23

removed old readme text

511. By Matthew Allen on 2015-12-23

fixed readmes

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'README'
2--- README 2014-11-11 19:20:57 +0000
3+++ README 2015-12-23 17:04:52 +0000
4@@ -1,169 +1,14 @@
5-# Ubuntu File Manager
6-
7-File manager app for Ubuntu on the desktop and on mobile devices.
8-
9-## Building the app
10-
11-### For the desktop
12-
13-Install the following build dependencies:
14-
15- sudo apt-get install libtag1-dev libpam0g-dev python3
16-
17-Then open the CMakeLists.txt file in Qt Creator, and ensure that the kit
18-selected on the left sidebar (just above the green "Run" button) is "Desktop"
19-
20-### For a device
21-
22-If you don't have one already, you'll need to create an armhf chroot to
23-cross-compile the app (also do this if you have an older armhf chroot, for
24-example 14.04 and current target is 14.10. You can first delete the old target
25-and then create a current one). Here's how:
26-
27-1. In Qt Creator, open the CMakeLists.txt file
28-2. Go to Tools > Options > Ubuntu > Click
29-2. Click on Create Click Target
30-3. Follow the prompts to generate the chroot. You will be asked for your sudo
31- password
32-4. Once created, you'll need to add the build dependencies for the app:
33- - Click on the Maintain button on your chroot
34- - On the terminal prompt that is started, type
35- apt-get install libtag1-dev:armhf libpam0g-dev:armhf python3
36- - Close the terminal when the installation finishes
37-5. Now you can either do a clean checkout and wait to be prompted by Qt Creator
38- to add the armhf kit, or alternatively:
39-6. Go to the Projects tab > Add kit and then select the UbuntuSDK armhf kit
40-
41-Additionally, you'll have to tell Qt Creator that you are doing a build for a
42-device to ultimately create a click package for installation:
43-
44-1. In Qt Creator, go to the Projects tab on the sidebar
45-2. Click on the "Build" subtab of the "UbuntuSDK for armhf..." tab
46-3. Then go to the "CMake arguments" text field and add "-DCLICK_MODE=on"
47- without the quotes
48-
49-Before starting the build make sure to select the "UbuntuSDK" kit on Qt
50-Creator's left sidebar (just above the green "Run" button).
51-
52-### Doing the build
53-
54-Ensure you've selected the kit you want for your build and press the build
55-button on Qt Creator's left sidebar (or alternatively Ctrl+B).
56-
57-## Running the app
58-
59-### On the desktop
60-
61-No additional steps are required before running the app on the desktop.
62-
63-You can pass two switches to run in phone or tablet mode from the desktop:
64-
65--p for phone mode
66--t for tablet mode
67-
68-
69-### On a device
70-
71-Due to Qt Creator's bug #1312094 in launchpad.net, there needs to be a manual
72-workaround done before the app can run on the device:
73-
74-1. Modify the desktop.in file: change the Exec line to read:
75- Exec=lib/arm-linux-gnueabihf/bin/@EXEC@
76-
77-Remember to revert this temporary change if you are building a click package or
78-if you're making other changes to be committed to the code!
79-
80-### Starting the app
81-
82-Ensure you've selected the kit you want for your build and press the run
83-button on Qt Creator's left sidebar (or alternatively Ctrl+R).
84-
85-If the app hasn't been built yet, or if there are pending changes that require
86-a build, the app will automatically be built first before running.
87-
88-If you're starting the app on a device, the build will be copied over and the
89-code will run unconfined.
90-
91-## Building a click package
92-
93-There are two alternative ways of building a click package.
94-
95-### Using Qt Creator
96-
97-1. Ensure you've selected the UbuntuSDK for armhf kit on Qt Creator's sidebar
98-2. Click on Publish on the sidebar
99-3. Click on "Create package"
100-4. If all goes well, you'll find the final click package in the build directory
101-
102-Notes:
103-- You can see the output of the click build if you click on Edit on the sidebar
104- and then "Application Output" at the bottom. This is useful to identify any
105- failures during the build
106-- Run `sudo apt-get install click-reviewers-tools` to enable click package
107- validation in Qt Creator. You might need to restart Qt Creator after you've
108- installed them for it to detect them
109-
110-### Using click-buddy
111-
112-1. Install phablet-tools: `sudo apt-get install phablet-tools`
113-2. Run click-buddy in your source tree:
114- click-buddy --dir . --arch armhf --framework ubuntu-sdk-14.04
115-3. Once finished, click-buddy will tell you the location of your source package
116-
117-## Installing a click package
118-
119-First of all, ensure you've got a working Ubuntu device attached over USB to
120-your host computer
121-
122-### Manually
123-
124-Run the following commands to manually install the click package (replace 0.5
125-with the version of your package):
126-
127- adb push com.ubuntu.filemanager_0.3.latest_armhf.click /home/phablet/
128- adb shell
129- sudo -H -u phablet pkcon install-local /home/phablet/com.ubuntu.filemanager_0.3_armhf.click
130-
131-### Using click-buddy
132-
133-You can add the --provision argument to the previous command to install the
134-click package on the device.
135-
136-### Starting the app
137-
138-1. Either kill unity8 with `pkill unity8` or restart the system for the Apps
139- (click) scope to pick up your newly installed click package
140-2. Search for Reminders in the Apps scope and tap on its icon to start it
141-3. You'll find the runtime logs at ~/.cache/upstart/application-click/
142-
143-## Uninstalling a click package
144-
145-Run the following commands, replacing the version of the click package you want
146-to uninstall:
147-
148- adb shell
149- sudo -iu phablet
150- sudo click unregister com.ubuntu.filemanager 0.3
151-
152-## Run the autopilot tests
153-
154-Prerequisites:
155- sudo apt-get install ubuntu-ui-toolkit-autopilot
156-
157-Once the app has been built, you can go to the build directory and run:
158-
159- cd tests/autopilot
160- autopilot3 run filemanager
161-
162-You can run filemanager in phone or tablet mode passing one of these two switches:
163-
164--p for phone mode
165--t for tablet mode
166-
167-so:
168-
169-autopilot3 launch ../../src/app/filemanager -p
170-
171-will launch filemanager with autopilot in phone mode.
172-
173-
174+ReadMe - Ubuntu Filemanager
175+===========================
176+
177+File Manager is a powerful but familiar tool for managing files. File Manager supports typical operations like cut/copy/paste and supports removable storage where available. File Manager makes effective use of space on small form factor devices, and expands to use more space on larger displays.
178+
179+File Manager is written in QML and C++ using the Ubuntu SDK and is licensed under the GPLv3.
180+
181+Useful Links
182+============
183+
184+Here are some useful links with regards to the Filemanager development.
185+
186+* [Home Page](https://developer.ubuntu.com/en/community/core-apps/file-manager/)
187+* [Project Page](https://code.launchpad.net/ubuntu-filemanager-app)
188
189=== added file 'README.autopilot'
190--- README.autopilot 1970-01-01 00:00:00 +0000
191+++ README.autopilot 2015-12-23 17:04:52 +0000
192@@ -0,0 +1,55 @@
193+Running Autopilot tests
194+=======================
195+
196+Ubuntu Clock App follows a test driven development where autopilot tests are
197+run before every merge into trunk. If you are submitting your bugfix/patch to
198+the clock app, please follow the following steps below to ensure that all tests
199+pass before proposing a merge request.
200+
201+If you are looking for more info about Autopilot or writing AP tests for the
202+clock app, here are some useful links to help you:
203+
204+* (Quality - Ubuntu Developers)[http://developer.ubuntu.com/start/quality]
205+* (Python Autopilot for 1.5.0)[https://developer.ubuntu.com/api/autopilot/python/1.5.0/]
206+
207+For help and options on running tests, [see here](https://developer.ubuntu.com/en/start/platform/guides/running-autopilot-tests/)
208+
209+Prerequisites
210+=============
211+
212+Install the following autopilot packages required to run the tests,
213+ $ sudo apt-get install python3-autopilot libautopilot-qt ubuntu-ui-toolkit-autopilot python3-autopilot-vis
214+
215+Running tests on the desktop
216+============================
217+
218+Using terminal:
219+
220+* Branch the filemanager app code,
221+ $ bzr branch lp:ubuntu-filemanager-app
222+
223+* Build the filemanager app as outlined in README.developers
224+
225+* Navigate to the tests/autopilot directory.
226+ $ cd tests/autopilot
227+
228+* run all tests.
229+ $ autopilot3 run -vv filemanager
230+
231+ to list all tests:
232+ $ autopilot3 list filemanager
233+
234+
235+Running tests on the desktop in phone or tablet mode
236+====================================================
237+
238+You can run filemanager in phone or tablet mode passing one of these two switches:
239+
240+-p for phone mode
241+-t for tablet mode
242+
243+so:
244+
245+ $ autopilot3 launch ../../src/app/filemanager -p
246+
247+will launch filemanager with autopilot in phone mode.
248\ No newline at end of file
249
250=== added file 'README.developers'
251--- README.developers 1970-01-01 00:00:00 +0000
252+++ README.developers 2015-12-23 17:04:52 +0000
253@@ -0,0 +1,154 @@
254+ReadMe Developers - Ubuntu Filemanager
255+===========================
256+
257+Building and running on Desktop
258+===============================
259+
260+Obtain the source:
261+
262+ $ bzr branch lp:ubuntu-filemanager-app
263+
264+Install the following build dependencies:
265+
266+ $ sudo apt-get install libtag1-dev libpam0g-dev python3
267+
268+Then open the CMakeLists.txt file in Qt Creator, and ensure that the kit
269+selected on the left sidebar (just above the green "Run" button) is "Desktop"
270+
271+# Starting the App
272+
273+No additional steps are required before running the app on the desktop.
274+
275+You can pass two switches to run in phone or tablet mode from the desktop:
276+
277+-p for phone mode
278+-t for tablet mode
279+
280+Due to Qt Creator's bug #1312094 in launchpad.net, there needs to be a manual
281+workaround done before the app can run on the device:
282+
283+1. Modify the desktop.in file: change the Exec line to read:
284+ Exec=lib/arm-linux-gnueabihf/bin/@EXEC@
285+
286+Remember to revert this temporary change if you are building a click package or
287+if you're making other changes to be committed to the code!
288+
289+Building and running on a Device
290+================================
291+
292+If you don't have one already, you'll need to create an armhf chroot to
293+cross-compile the app (also do this if you have an older armhf chroot, for
294+example 14.04 and current target is 14.10. You can first delete the old target
295+and then create a current one). Here's how:
296+
297+1. In Qt Creator, open the CMakeLists.txt file
298+2. Go to Tools > Options > Ubuntu > Click
299+2. Click on Create Click Target
300+3. Follow the prompts to generate the chroot. You will be asked for your sudo
301+ password
302+4. Once created, you'll need to add the build dependencies for the app:
303+ - Click on the Maintain button on your chroot
304+ - On the terminal prompt that is started, type
305+ apt-get install libtag1-dev:armhf libpam0g-dev:armhf python3
306+ - Close the terminal when the installation finishes
307+5. Now you can either do a clean checkout and wait to be prompted by Qt Creator
308+ to add the armhf kit, or alternatively:
309+6. Go to the Projects tab > Add kit and then select the UbuntuSDK armhf kit
310+
311+Additionally, you'll have to tell Qt Creator that you are doing a build for a
312+device to ultimately create a click package for installation:
313+
314+1. In Qt Creator, go to the Projects tab on the sidebar
315+2. Click on the "Build" subtab of the "UbuntuSDK for armhf..." tab
316+3. Then go to the "CMake arguments" text field and add "-DCLICK_MODE=on"
317+ without the quotes
318+
319+Before starting the build make sure to select the "UbuntuSDK" kit on Qt
320+Creator's left sidebar (just above the green "Run" button).
321+
322+Ensure you've selected the kit you want for your build and press the build
323+button on Qt Creator's left sidebar (or alternatively Ctrl+B).
324+
325+# Starting the App
326+
327+Ensure you've selected the kit you want for your build and press the run
328+button on Qt Creator's left sidebar (or alternatively Ctrl+R).
329+
330+If the app hasn't been built yet, or if there are pending changes that require
331+a build, the app will automatically be built first before running.
332+
333+If you're starting the app on a device, the build will be copied over and the
334+code will run unconfined.
335+
336+
337+Building a click package
338+========================
339+
340+There are two alternative ways of building a click package.
341+
342+### Using Qt Creator
343+
344+1. Ensure you've selected the UbuntuSDK for armhf kit on Qt Creator's sidebar
345+2. Click on Publish on the sidebar
346+3. Click on "Create package"
347+4. If all goes well, you'll find the final click package in the build directory
348+
349+Notes:
350+- You can see the output of the click build if you click on Edit on the sidebar
351+ and then "Application Output" at the bottom. This is useful to identify any
352+ failures during the build
353+- Run `sudo apt-get install click-reviewers-tools` to enable click package
354+ validation in Qt Creator. You might need to restart Qt Creator after you've
355+ installed them for it to detect them
356+
357+### Using click-buddy
358+
359+ 1. Install phablet-tools:
360+
361+ $ sudo apt-get install phablet-tools
362+
363+ 2. Run click-buddy in your source tree:
364+
365+ $ click-buddy --dir . --arch armhf --framework ubuntu-sdk-14.04
366+
367+ 3. Once finished, click-buddy will tell you the location of your source package
368+
369+### Installing a click package
370+
371+First of all, ensure you've got a working Ubuntu device attached over USB to
372+your host computer
373+
374+#### Manually
375+
376+Run the following commands to manually install the click package (replace 0.5
377+with the version of your package):
378+
379+ $ adb push com.ubuntu.filemanager_0.3.latest_armhf.click /home/phablet/
380+ $ adb shell
381+ $ sudo -H -u phablet pkcon install-local /home/phablet/com.ubuntu.filemanager_0.3_armhf.click
382+
383+#### Using click-buddy
384+
385+You can add the --provision argument to the previous command to install the
386+click package on the device.
387+
388+### Starting the app
389+
390+1. Either kill unity8 with `pkill unity8` or restart the system for the Apps
391+ (click) scope to pick up your newly installed click package
392+2. Search for Reminders in the Apps scope and tap on its icon to start it
393+3. You'll find the runtime logs at ~/.cache/upstart/application-click/
394+
395+### Uninstalling a click package
396+
397+Run the following commands, replacing the version of the click package you want
398+to uninstall:
399+
400+ $ adb shell
401+ $ sudo -iu phablet
402+ $ sudo click unregister com.ubuntu.filemanager 0.3
403+
404+Running Tests
405+=============
406+
407+Please check README.autopilot on how to run tests.
408\ No newline at end of file
409
410=== modified file 'README.translations'
411--- README.translations 2014-08-16 07:04:04 +0000
412+++ README.translations 2015-12-23 17:04:52 +0000
413@@ -1,3 +1,6 @@
414+ReadMe Translations - Ubuntu Filemanager
415+===========================
416+
417 # Updating translations
418
419 Translations for the Filemanager app happen in [Launchpad Translations][] and
420@@ -10,10 +13,15 @@
421 translatable messages to translators. So whenever you add new translatable
422 messages in the code, make sure to follow these steps:
423
424- 1. Run click-buddy retaining the build directory:
425- `click-buddy --dir . --no-clean`
426- 2. Commit the generated .pot file: `bzr commit -m"Updated translation template"`
427- 3. Push the branch and send a merge proposal as usual
428+ 1. Run click-buddy retaining the build directory:
429+
430+ $ click-buddy --dir . --no-clean
431+
432+ 2. Commit the generated .pot file:
433+
434+ $ bzr commit -m"Updated translation template"
435+
436+ 3. Push the branch and send a merge proposal as usual
437
438 And that's it, once the branch lands Launchpad should take care of all the rest!
439
440@@ -32,5 +40,5 @@
441
442 Translations for core apps follow the standard [gettext format].
443
444- [Launchpad Translations]: https://translations.launchpad.net/ubuntu-filemanager-app
445- [gettext format]: https://www.gnu.org/software/gettext/
446+ [Launchpad Translations](https://translations.launchpad.net/ubuntu-filemanager-app)
447+ [gettext format](https://www.gnu.org/software/gettext/)

Subscribers

People subscribed via source and target branches