ignore compiled readme

[enigma2-curlytx.git] / README.rst

diff --git a/README.rst b/README.rst
index a5c3716a8ea9cdccf80ab322ebb0af2817b358c8..f497390ab7b89769edb1ed7856313fea9069a0f9 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,28 +1,42 @@
-=======
+*******
 CurlyTx
-=======
+*******
 Enigma2 (Dreambox) plugin that lets you view the contents of remote
-plain text files, e.g. HTTP.
+*plain text* files, e.g. HTTP URLs.
 
 Multiple URLs can be configured and navigated.
 
+.. contents::
+   :depth: 2
 
 
-Open issues
-===========
-- hide default page selection when no page defined
-- page import via atom feed/opml
-- move mode to re-order pages
-- show current page when multiple ones are defined: "2/6"
-- configurable text size per page
-- how to show clock in lcd?
+========
+Features
+========
+- Load any remote plain text files, e.g. via HTTP
+- Unlimited number of remote URLs/pages
+- Reload pages
+- Show HTTP headers
+- Configurable page titles
+- Configurable default page
+- Import complete page list from Atom feed
+- Visible in the main menu or the extension menu (configurable)
+- Configurable menu title
+- Help screen for main window and settings window
 
 
-License
-=======
-The plugin is subject to the GPLv3 or later.
+=====
+Usage
+=====
+
+FIXME
+
 
 
+=================
+Modifying CurlyTx
+=================
+
 
 Translation
 ===========
@@ -36,9 +50,47 @@ Replace ``$lang_code`` with your two-letter language code::
     $ ./compile.sh
 
 
+Editing an existing translation
+-------------------------------
+Simply run ::
+
+    $ cd po
+    $ ./update.sh
+
+This will update the translation template ``messages.pot`` from the source code
+and will merge the changes into the single translation files.
+
+
+Testing a translation
+---------------------
+Link your compiled translation file into ::
+
+    src/locale/$lang_code/LC_MESSAGES/CurlyTx.mo
+
+Enigma2 will pick it up automatically.
+
+
 Building
 ========
-ipkg-build:
+First upgrade the version number in ``CONTROL/control``.
+
+Then simply run ::
+
+    ./build.sh
+
+You will need the ``ipkg-build`` script from
  http://reichholf.net/files/dreambox/tools/ipkg-build
 
-http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen
+Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen
+
+
+Open issues
+===========
+- move mode to re-order pages
+- how to show clock in lcd?
+
+
+=======
+License
+=======
+The plugin is subject to the GPLv3 or later.