Added some context to XScreensaver config file in WolframAutomata README.
authorAaron Taylor <ataylor@subgeniuskitty.com>
Thu, 10 Jun 2021 21:59:07 +0000 (14:59 -0700)
committerAaron Taylor <ataylor@subgeniuskitty.com>
Thu, 10 Jun 2021 21:59:07 +0000 (14:59 -0700)
hacks/WolframAutomata/README.md

index 026b9cf..751108f 100644 (file)
@@ -212,7 +212,7 @@ XScreensaver via whatever method is appropriate for your operating system. The
 following instructions assume the filesystem paths used by FreeBSD packages and
 ports; your paths may differ. After XScreensaver installation, ensure all
 pertinent config files are created by running `xscreensaver-demo` and
 following instructions assume the filesystem paths used by FreeBSD packages and
 ports; your paths may differ. After XScreensaver installation, ensure all
 pertinent config files are created by running `xscreensaver-demo` and
-configuring it for your system.
+configuring XScreensaver for your system.
 
 After XScreensaver is configured and working on your system, ensure that
 WolframAutomata runs in standalone mode on your system. If you can `make clean run`
 
 After XScreensaver is configured and working on your system, ensure that
 WolframAutomata runs in standalone mode on your system. If you can `make clean run`
@@ -235,19 +235,28 @@ example, on FreeBSD:
 
     TODO: Finish writing this file after the command line options are finalized.
 
 
     TODO: Finish writing this file after the command line options are finalized.
 
-The final step integrates WolframAutomata into an individual user's
-XScreensaver framework. If preferred, it could instead be done in the global
-XScreensaver config.
+The next step integrates WolframAutomata into an individual user's XScreensaver
+config via the file `~/.xscreensaver`. If preferred, it could instead be done
+in the global XScreensaver config.
 
 
-Add the WolframAutomata entry under the `programs:` label, in the same list as
-all the other hacks. Position in the list is irrelevant, but ensure you don't
-paste WolframAutomata's entry into the middle of pre-existing, multi-line
-entries.
+In the `~/.xscreensaver` file, create a WolframAutomata entry under the
+`programs:` label in the same list as all the other hacks. Position in the
+list is irrelevant, but ensure you don't paste WolframAutomata's entry into the
+middle of pre-existing, multi-line entries. For context, the example below
+includes a multi-line entry, a GL entry and a plain entry. All that is needed
+is to insert the WolframAutomata line somewhere in the `programs:` list, as
+demonstrated.
 
     vi ~/.xscreensaver
 
 
     vi ~/.xscreensaver
 
+    <snip>
     programs:                                                                     \
     programs:                                                                     \
-                                    WolframAutomata -root -party-mode           \n\
+                                    xplanet -vroot -wait 1 -timewarp 400          \
+                                      -label -origin moon                       \n\
+      GL:                           fireflies -root                             \n\
+                                    WolframAutomata -root                       \n\
+                                    blitspin -root                              \n\
+    <snip>
 
 That's all. Now you can run `xscreensaver-demo` and select WolframAutomata just
 like any other hack.
 
 That's all. Now you can run `xscreensaver-demo` and select WolframAutomata just
 like any other hack.