From: Aaron Taylor <ataylor@subgeniuskitty.com>
Date: Fri, 11 Jun 2021 02:34:28 +0000 (-0700)
Subject: Updated XScreensaver integration notes for WolframAutomata now that CLI flags are... 
X-Git-Url: http://git.subgeniuskitty.com/screensavers/.git/commitdiff_plain/e2ec7b68f9a24b79dab6335d0dc1c067f081962d

Updated XScreensaver integration notes for WolframAutomata now that CLI flags are finished.
---

diff --git a/hacks/WolframAutomata/README.md b/hacks/WolframAutomata/README.md
index d3546d1..9c14b8c 100644
--- a/hacks/WolframAutomata/README.md
+++ b/hacks/WolframAutomata/README.md
@@ -225,15 +225,59 @@ example, with prerequisite steps spelled out:
     git clone git://git.subgeniuskitty.com/screensavers
     cd screensavers/hacks/WolframAutomata
     make clean all
-    cp WolframAutomata /usr/local/bin/xscreensaver-hacks/
+    cp WolframAutomata /usr/local/bin/xscreensaver-hacks/wolframautomata
 
-Now create the file `WolframAutomata.xml` wherever your system stores
+Now create the file `wolframautomata.xml` wherever your system stores
 XScreensaver config files and populate it with the contents shown below. For
 example, on FreeBSD:
 
-    vi /usr/local/share/xscreensaver/config/WolframAutomata.xml
-
-    TODO: Finish writing this file after the command line options are finalized.
+    vi /usr/local/share/xscreensaver/config/wolframautomata.xml
+
+    <?xml version="1.0" encoding="ISO-8859-1"?>
+    
+    <screensaver name="wolframautomata" _label="WolframAutomata">
+    
+      <command arg="-root"/>
+    
+      <string  id="rule_number"       _label="Rule number: "             arg="-rule %" />
+      <boolean id="random_rule"       _label="Random rule"               arg-set="-random-rule" />
+    
+      <string  id="seed_density"      _label="Seed density (percent): "  arg="-seed-density %" />
+      <boolean id="seed_left"         _label="Seed left"                 arg-set="-seed-left" />
+      <boolean id="seed_center"       _label="Seed center"               arg-set="-seed-center" />
+      <boolean id="seed_right"        _label="Seed right"                arg-set="-seed-right" />
+    
+      <string  id="length"            _label="Length (generations): "    arg="-length %" />
+      <boolean id="random_length"     _label="Random length"             arg-set="-random-length" />
+    
+      <string  id="delay"             _label="Delay (usec): "            arg="-delay %" />
+      <boolean id="random_delay"      _label="Random delay"              arg-set="-random-delay" />
+    
+      <string  id="cell_size"         _label="Cell size (px): "          arg="-cell-size %" />
+      <boolean id="random_cell_size"  _label="Random cell size"          arg-set="-random-cell-size" />
+    
+      <string  id="color_index"       _label="Color index (index): "     arg="-color-index %" />
+    
+      <string  id="admiration_window" _label="Admiration window (sec): " arg="-admiration-delay %" />
+    
+      <_description>
+    Displays the time evolution of elementary cellular automata.
+    
+    These automata consist of a line of cells, each of which may be either on or
+    off. To ensure every cell has neighbors, the two endpoints of the line connect
+    together, thereby forming a circular universe for the cells to inhabit. This
+    line is drawn horizontally on the screen.
+    
+    Over time, this line of cells evolves according to rules, with some cells
+    switching on or off. Each new iteration is drawn below its predecessor,
+    leading the screen to scroll vertically over time.
+    
+    The rules which govern the time evolution of this system depend only on the
+    current state of a given cell and the state of its two immediate neighbors.
+    These rules are formalized as Wolfram codes, where the code number is directly
+    convertible into a rule set.
+      </_description>
+    </screensaver>
 
 The next step integrates WolframAutomata into an individual user's XScreensaver
 config via the file `~/.xscreensaver`. If preferred, it could instead be done
@@ -254,7 +298,7 @@ demonstrated.
                                     xplanet -vroot -wait 1 -timewarp 400          \
                                       -label -origin moon                       \n\
       GL:                           fireflies -root                             \n\
-                                    WolframAutomata -root                       \n\
+                                    wolframautomata -root                       \n\
                                     blitspin -root                              \n\
     <snip>