add encoding and copyright header
[enigma2-curlytx.git] / README.rst
1 =======
2 CurlyTx
3 =======
4 Enigma2 (Dreambox) plugin that lets you view the contents of remote
5 plain text files, e.g. HTTP.
6
7 Multiple URLs can be configured and navigated.
8
9
10
11 Open issues
12 ===========
13 - move mode to re-order pages
14 - how to show clock in lcd?
15
16
17 License
18 =======
19 The plugin is subject to the GPLv3 or later.
20
21
22
23 Translation
24 ===========
25 Beginning a new translation
26 ---------------------------
27 Replace ``$lang_code`` with your two-letter language code::
28
29     $ cd po
30     $ cp messages.po $lang_code.po
31     ... edit $lang_code.po now
32     $ ./compile.sh
33
34
35 Editing an existing translation
36 -------------------------------
37 Simply run ::
38
39     $ cd po
40     $ ./update.sh
41
42 This will update the translation template ``messages.pot`` from the source code
43 and will merge the changes into the single translation files.
44
45
46 Testing a translation
47 ---------------------
48 Link your compiled translation file into ::
49
50     src/locale/$lang_code/LC_MESSAGES/CurlyTx.mo
51
52 Enigma2 will pick it up automatically.
53
54
55 Building
56 ========
57 First upgrade the version number in ``CONTROL/control``.
58
59 Then simply run ::
60
61     ./build.sh
62
63 You will need the ``ipkg-build`` script from
64  http://reichholf.net/files/dreambox/tools/ipkg-build
65
66 Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen