fix login

[noxon-gateway.git] / README.rst

diff --git a/README.rst b/README.rst
index c84f3e4d1ef41265f9f4ff98298bb55726567d6d..afd652ef77d7dc1276f5ca5a3987096120e006ac 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,8 @@
 ********************
 Noxon iRadio gateway
 ********************
 ********************
 Noxon iRadio gateway
 ********************

-Push your own content onto Noxon iRadio devices.
+Push your own content onto Noxon iRadio devices:
+RSS feeds, text files and MediaTomb server structures.

 
 This tool makes it possible to push own data into the menu
 entries
 
 This tool makes it possible to push own data into the menu
 entries


@@ -11,11 +12,78 @@ entries
 - My Noxon
 
 
 - My Noxon
 
 

-================
-Adding a podcast
-================
-Create a file "Title.url" in ``var/podcasts/`` and write
-the URL of the podcast MP3 RSS feed into it.
+===================================
+Customizung the directory structure
+===================================
+The ``var/`` directory contains three directories you can fill with
+your own content.
+
+================ ==================
+Menu item        ``var/`` Directory
+================ ==================
+Internet Radio   ``internetradio``
+Podcasts         ``podcasts``
+My Noxon         ``mynoxon``
+================ ==================
+
+You can put folders and files into this directories.
+
+The ``internetradio`` directory is hard-coded to display the contents
+of a MediaTomb UPnP server.
+You can remove the check in ``index.php#handleRequest()`` if you do not
+want this.
+
+
+File types
+==========
+Directory
+  A directory is browsable by your Noxon radio
+``.sh`` file
+  Shell script which is shown as directory and which gets executed
+  when navigating into it.
+  Output is shown as it is for ``.txt`` files.
+
+  I use it to control my house's heating system from the radio.
+``.auto.sh``
+  Shell script which gets executed when browsing the folder.
+  The output is integrated into the directory listing with the same
+  rules as for ``.txt`` files.
+
+  You can use this to show the current time within the directory listing.
+``.txt`` file
+  Text files are rendered as un-actionable lists.
+
+  Empty lines get removed, consecutive spaces get collapsed.
+``.url`` file
+  Podcast feed URL file.
+
+  Simply contains the URL to the podcast's MP3 RSS feed.
+
+File extensions get removed for display purposes.
+
+
+Sorting
+=======
+Files and directory are sorted alphabetically and get listed
+in this order.
+
+You can prefix your files and directories with ``[0-9]+_``,
+which lets you influence sorting and gets removed in the
+listings.
+
+Consider the following files::
+
+    01_temp.auto.sh
+    02_warmer.sh
+    03_colder.sh
+
+Would render as::
+
+    Temperature: 23°C
+    warmer
+    colder
+
+(given that ``01_temp.auto.sh`` outputs the temperature string)

 
 
 =====
 
 
 =====


@@ -32,6 +100,12 @@ by this tool::
     gatekeeper.my-noxon.net
 
 
     gatekeeper.my-noxon.net
 
 

+MediaTomb
+=========
+To be able to browse a MediaTomb server, copy ``data/config.php.dist`` to
+``data/config.php`` and fill it with mediatomb web interface credentials.
+
+

 =======
 License
 =======
 =======
 License
 =======