about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2021-11-03 16:49:04 +0530
committerAndinus <andinus@nand.sh>2021-11-03 16:49:04 +0530
commit5b3ab457dbeb897802f9515fc09d65f1d013a40f (patch)
tree1319c3d0f7db8c02cad0a2a614f66fb175c22ed7
parent846b64b766f7eccdd3696603bf44b54231f03fa6 (diff)
downloadfornax-5b3ab457dbeb897802f9515fc09d65f1d013a40f.tar.gz
Document highlighting for Illegal, Solved paths
-rw-r--r--README9
-rw-r--r--README.org9
2 files changed, 14 insertions, 4 deletions
diff --git a/README b/README
index b527d21..314a00f 100644
--- a/README
+++ b/README
@@ -35,6 +35,9 @@ This collection includes:
   Fornax parses /Fornax format/, generates a `PNG' for each iteration
   which is later converted to a slideshow with `ffmpeg'.
 
+  • Solved paths are highlighted if the iteration is preceded by `|'.
+  • Illegal paths are highlighted if the iteration is preceded by `!'.
+
 
 2 Fornax Format
 ═══════════════
@@ -59,8 +62,10 @@ This collection includes:
       columns) + 1' then it may be ignored by the program that parses
       the file.
 
-  • Solved iteration must be preceded by `|' character. The program may
-    or may not use it while rendering the video.
+  • Solved iteration can be preceded by `|' character.
+
+  • Iteration that tries to walk on a blocked path can be preceded by
+    `!' character.
 
 
 2.1 Grids
diff --git a/README.org b/README.org
index abd8028..d641d65 100644
--- a/README.org
+++ b/README.org
@@ -17,6 +17,9 @@ This collection includes:
 Fornax parses /Fornax format/, generates a ~PNG~ for each iteration which is
 later converted to a slideshow with ~ffmpeg~.
 
+- Solved paths are highlighted if the iteration is preceded by ~|~.
+- Illegal paths are highlighted if the iteration is preceded by ~!~.
+
 * Fornax Format
 
 Fornax format is an intermediate output file generated after solving the
@@ -38,8 +41,10 @@ columns is known, the whole grid should be printed in a single line.
   columns) + 1~ then it may be ignored by the program that parses the
   file.
 
-- Solved iteration must be preceded by ~|~ character. The program may or
-  may not use it while rendering the video.
+- Solved iteration can be preceded by ~|~ character.
+
+- Iteration that tries to walk on a blocked path can be preceded by ~!~
+  character.
 
 ** Grids