X-Git-Url: https://git.cweiske.de/enigma2-curlytx.git/blobdiff_plain/a243939e28f00fef2002c75ae795ff42b7385263..dee08032dd347bdb30772bc239814b8339c17977:/README.rst?ds=sidebyside

diff --git a/README.rst b/README.rst
index f9b28ec..f497390 100644
--- a/README.rst
+++ b/README.rst
@@ -1,23 +1,41 @@
-=======
+*******
 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
-===========
-- move mode to re-order pages
-- 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
+
+
+=====
+Usage
+=====
+
+FIXME
 
 
-License
-=======
-The plugin is subject to the GPLv3 or later.
 
+=================
+Modifying CurlyTx
+=================
 
 
 Translation
@@ -32,6 +50,26 @@ 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
 ========
 First upgrade the version number in ``CONTROL/control``.
@@ -44,3 +82,15 @@ You will need the ``ipkg-build`` script from
  http://reichholf.net/files/dreambox/tools/ipkg-build
 
 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.