Added README for ch1-breeding-numbers experiment.
authorAaron Taylor <ataylor@subgeniuskitty.com>
Sun, 9 May 2021 11:26:16 +0000 (04:26 -0700)
committerAaron Taylor <ataylor@subgeniuskitty.com>
Sun, 9 May 2021 11:26:16 +0000 (04:26 -0700)
chapter-1-experiments/README.md [new file with mode: 0644]

diff --git a/chapter-1-experiments/README.md b/chapter-1-experiments/README.md
new file mode 100644 (file)
index 0000000..ce4c6ec
--- /dev/null
@@ -0,0 +1,31 @@
+# Overview #
+
+Program to breed N generations of surreal numbers and arrange them in order.
+
+# Status #
+
+Fully functional and tested on Debian 10.9 with Go 1.16.3.
+
+# Usage #
+
+Sample output is shown below for four generations. The vertical axis plots the
+numberline from smallest to largest and the horizontal axis plots generation.
+
+    % ./ch1-breeding-numbers -generations 4
+    .          .               .               aas = <---|aag>
+    .          .               aag = <---|aac>
+    .          .               .               aal = <aag|aac>
+    .          aac = <---|aaa>
+    .          .               .               aam = <aac|aad>
+    .          .               aad = <aac|aaa>
+    .          .               .               aan = <aad|aaa>
+    aaa = <---|--->
+    .          .               .               aao = <aaa|aae>
+    .          .               aae = <aaa|aab>
+    .          .               .               aap = <aae|aab>
+    .          aab = <aaa|--->
+    .          .               .               aaq = <aab|aaj>
+    .          .               aaj = <aab|--->
+    .          .               .               abd = <aaj|--->
+    After 4 generations, the universe contains 15 numbers.
+    If output looks poor, ensure tabstop is eight spaces and that output doesn't wrap.