~dholbach/help-app/1423871

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
Welcome to Help for Ubuntu devices!
===================================


Prerequisites
-------------

Before you get started, run:

	sudo apt install python-pelican po4a make bzr ubuntu-html5-ui-toolkit


Editing
-------

This app is structured in a very simple way. All the content is and all your
edits happen in

	./edit-here/content/

The markup for the text is Markdown, which is very easy to learn. Just have 
a look at http://daringfireball.net/projects/markdown/ and some of the 
existing files to get started.

Once you're happy with your edits, change to the top-level directory and run

	make html

This will also generate translated pages.

You can find the updated HTML in ./app/www/. For instance, you can browse 
the site in firefox with

firefox app/www/index.html


Creating a click
----------------

To create a click package (for example, if you want to test it on your
device), just run

	make click

in the top-level directory.


Code, bugs, etc.
----------------

To file bugs, or view/submit merge proposals, simply use this project in
Launchpad:

	https://launchpad.net/ubuntu-devices-help

To update the .pot file, simply run the following command in the edit-here/
directory:

	make update-pot

If you want to get help with the app or anything else, ask the fine folks
in #ubuntu-app-devel - for example dholbach, mhall119 or dpm.

Thanks a lot for helping out!