support nocache files to disable caching

[noxon-gateway.git] / README.rst

diff --git a/README.rst b/README.rst
index 1d3d3a307a586205982ff37470a006f56f067dc9..adb2c5c289b1851028d7d7985d3732dc7fd3e34a 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -153,6 +153,8 @@ executable file
   rules as for ``.txt`` files.
 
   You can use this to show the current time within the directory listing.
+``nocache``
+  Disables menu caching.
 
 File extensions get removed for display purposes.
 
@@ -181,6 +183,18 @@ Would render as::
 (given that ``01_temp.auto.sh`` outputs the temperature string)
 
 
+Caching
+=======
+When going back in the menu strucutre with the left arrow button,
+Noxon iRadios display a cached version of the menu.
+
+If you do not want this - because a script modified values that are
+displayed in the parent menu, or because the script that displays
+the time should always be run - you may disable caching.
+
+Caching is disabled when a file named ``nocache`` is found in the directory.
+
+
 =====
 Setup
 =====