Miscellaneous documentation fixes/updates.

cosinekitty · Dec 9, 2024 · 9da4a8e · 9da4a8e
1 parent 23c5f2e
commit 9da4a8e
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 11 deletions.
diff --git a/Chaops.md b/Chaops.md
@@ -6,7 +6,7 @@ The name "Chaops" is an abbreviation of "chaos operators". Chaops is a left-expa
 
 ### Memory
 
-The section labeled MEMORY allows you to select one of 16 memory cells with addresses numbered 0..15.
+The section labeled MEMORY allows you to select one of 16 memory cells with addresses numbered 0..15. You can then store/recall the state of the chaos module to the right at any time. This allows you to create repetitive chaotic control signals, or to restart a known state for reproducible results.
 
 Immediately below the MEMORY label, from left to right, are a CV input port, a smaller attenuverter knob, and a larger manual selector knob. Turning the selector knob changes the active memory cell address, as reflected in the LED display.
 

diff --git a/Glee.md b/Glee.md
@@ -75,6 +75,8 @@ Each fruit name starts with the same letter as the Aizawa parameter being contro
 * Cantaloupe for $C$. (This mode is boring, but kept for backward compatibility.)
 * Elderberry for $E$.
 
+The selected parameter A, B, C, or E appears on top of the CHAOS knob.
+
 When loading patches that were made before Glee supported chaos modes,
 Glee preserves backward compatibility by using Cantalope mode.
 

diff --git a/Lark.md b/Lark.md
@@ -79,6 +79,8 @@ Each animal name starts with the same letter as the Dequan Li parameter being co
 * Ferret for $F$.
 * Kangaroo for $K$.
 
+The selected parameter A, E, F, or K appears on top of the CHAOS knob.
+
 (The parameters $C$ and $D$ do not appear as chaos mode options because I discovered they did not produce sufficiently interesting or different behavior from the other parameters.)
 
 You can change the chaos mode by right-clicking on the CHAOS knob and selecting one of the chaos mode options:

diff --git a/README.md b/README.md
@@ -1,10 +1,12 @@
 # Sapphire modules for VCV Rack 2
 
 ## Installation
+
 The latest release of the Sapphire plugin is available in the
 [VCV Rack Library](https://library.vcvrack.com/CosineKitty-Sapphire).
 
 ## Video gallery
+
 Videos of [VCV Rack patches using Sapphire modules](VideoGallery.md) by myself and others.
 No talking, just patching and listening.
 
@@ -36,8 +38,7 @@ hexagonal mesh of balls and springs.
 
 ## Frolic
 
-A low-frequency and ultra-low-frequency chaotic oscillator
-for generating 3 simultaneous smooth but unpredictable voltages.
+A chaotic oscillator for generating 3 simultaneous smooth but unpredictable voltages.
 
 <a href="Frolic.md">Sapphire Frolic documentation</a>
 
@@ -59,8 +60,7 @@ by [Chris Johnson](https://github.com/airwindows/airwindows).
 
 ## Glee
 
-A low-frequency and ultra-low-frequency chaotic oscillator
-for generating 3 simultaneous smooth but unpredictable voltages.
+A chaotic oscillator for generating 3 simultaneous smooth but unpredictable voltages.
 
 <a href="Glee.md">Sapphire Glee documentation</a>
 
@@ -91,8 +91,7 @@ A random vector generator whose outputs point in all directions of an N-dimensio
 
 ## Lark
 
-A low-frequency and ultra-low-frequency chaotic oscillator
-for generating 3 simultaneous smooth but unpredictable voltages.
+A chaotic oscillator for generating 3 simultaneous smooth but unpredictable voltages.
 
 <a href="Lark.md">Sapphire Lark documentation</a>
 
@@ -180,7 +179,7 @@ Calculates the cross product of two input vectors.
 
 ---
 
-## Split/Add/Merge (SAM)
+## Split/Add/Merge
 
 Splits, adds, and/or merges a stereo or 3D polyphonic signal with 2 or 3 monophonic signals.
 This is like VCV Merge and VCV Split combined, but only for a maximum of 3 channels.

diff --git a/SplitAddMerge.md b/SplitAddMerge.md
@@ -1,4 +1,4 @@
-## Split/Add/Merge (SAM)
+## Split/Add/Merge
 
 ![Split/Add/Merge](images/splitAddMerge.png)
 

diff --git a/src/sam_vcv.cpp b/src/sam_vcv.cpp
@@ -1,7 +1,7 @@
 #include "sapphire_vcvrack.hpp"
 #include "sapphire_widget.hpp"
 
-// Sapphire SAM (Split / Add / Merge) for stereo and 3D vectors.
+// Sapphire Split/Add/Merge for stereo and 3D vectors.
 // by Don Cross <[email protected]>
 // https://github.com/cosinekitty/sapphire
 

diff --git a/src/sapphire_chaos_module.hpp b/src/sapphire_chaos_module.hpp
@@ -6,7 +6,7 @@
 
 // Don Cross <[email protected]>
 // https://github.com/cosinekitty/sapphire
-// Generic pattern for a Sapphire-style vector-output chaos module (Frolic & Glee).
+// Generic pattern for a Sapphire-style vector-output chaos module.
 
 namespace Sapphire
 {