update readme with build instructions
[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 Building
36 ========
37 First upgrade the version number in ``CONTROL/control``.
38
39 Then simply run ::
40
41     ./build.sh
42
43 You will need the ``ipkg-build`` script from
44  http://reichholf.net/files/dreambox/tools/ipkg-build
45
46 Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen