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