Add sorting prefix "[0-9]+_"

[noxon-gateway.git] / README.rst

diff --git a/README.rst b/README.rst
index 9d86b21832d7d8ef9a347cde026972d6352c3a9b..afd652ef77d7dc1276f5ca5a3987096120e006ac 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -62,6 +62,30 @@ Directory
 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)
+
+
 =====
 Setup
 =====