update readme with build instructions

[enigma2-curlytx.git] / README.rst

diff --git a/README.rst b/README.rst
index a7b98b035f9632c74f1078098b78001f833041db..f9b28ec3c0a61308673756088eba0b01bc4bc2ba 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -10,15 +10,37 @@ Multiple URLs can be configured and navigated.
 
 Open issues
 ===========
-- makefile
-- German translation
-- help screens
-- 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
-- show in plugin/extension menu (blue button)
+- how to show clock in lcd?
+
 
 License
 =======
 The plugin is subject to the GPLv3 or later.
+
+
+
+Translation
+===========
+Beginning a new translation
+---------------------------
+Replace ``$lang_code`` with your two-letter language code::
+
+    $ cd po
+    $ cp messages.po $lang_code.po
+    ... edit $lang_code.po now
+    $ ./compile.sh
+
+
+Building
+========
+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
+
+Also see http://dream.reichholf.net/wiki/Howto:IPK_Pakete_erstellen