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 URLs.
   6
   7 Multiple URLs can be configured and navigated.
   8
   9 .. contents::
  10    :depth: 2
  11
  12
  13 ========
  14 Features
  15 ========
  16 - Load any remote plain text files, e.g. via HTTP
  17 - Unlimited number of remote URLs/pages
  18 - Reload pages
  19 - Show HTTP headers
  20 - Configurable page titles
  21 - Configurable default page
  22 - Import complete page list from Atom feed
  23 - Visible in the main menu or the extension menu (configurable)
  24 - Configurable menu title
  25 - Help screen for main window and settings window
  26
  27
  28 =====
  29 Usage
  30 =====
  31
  32 FIXME
  33
  34
  35
  36 =================
  37 Modifying CurlyTx
  38 =================
  39
  40
  41 Translation
  42 ===========
  43 Beginning a new translation
  44 ---------------------------
  45 Replace ``$lang_code`` with your two-letter language code::
  46
  47     $ cd po
  48     $ cp messages.po $lang_code.po
  49     ... edit $lang_code.po now
  50     $ ./compile.sh
  51
  52
  53 Editing an existing translation
  54 -------------------------------
  55 Simply run ::
  56
  57     $ cd po
  58     $ ./update.sh
  59
  60 This will update the translation template ``messages.pot`` from the source code
  61 and will merge the changes into the single translation files.
  62
  63
  64 Testing a translation
  65 ---------------------
  66 Link your compiled translation file into ::
  67
  68     src/locale/$lang_code/LC_MESSAGES/CurlyTx.mo
  69
  70 Enigma2 will pick it up automatically.
  71
  72
  73 Building
  74 ========
  75 First upgrade the version number in ``CONTROL/control``.
  76
  77 Then simply run ::
  78
  79     ./build.sh
  80
  81 You will need the ``ipkg-build`` script from
  82  http://reichholf.net/files/dreambox/tools/ipkg-build
  83
  84 Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen
  85
  86
  87 Open issues
  88 ===========
  89 - move mode to re-order pages
  90 - how to show clock in lcd?
  91
  92
  93 =======
  94 License
  95 =======
  96 The plugin is subject to the GPLv3 or later.