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: 448 lines (+237/-175)
4 files modified
README.autopilot.md (+55/-0)
README.developers.md (+154/-0)
README.md (+14/-169)
README.translations.md (+14/-6)
To merge this branch: bzr merge lp:~whosdaz/ubuntu-filemanager-app/gci6198315054006272
Reviewer Review Type Date Requested Status
Andrew Hayzen (community) 2015-12-23 Needs Fixing on 2015-12-23
Ubuntu File Manager Developers 2015-12-23 Pending
Review via email: mp+281319@code.launchpad.net

This proposal supersedes a proposal from 2015-12-23.

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

To post a comment you must log in.
Andrew Hayzen (ahayzen) wrote : Posted in a previous version of this proposal

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
514. By Matthew Allen on 2015-12-23

Changed file extensions to .md

Andrew Hayzen (ahayzen) wrote :

3 minor inline comments, otherwise it looks good :-)

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

Subscribers

People subscribed via source and target branches