summaryrefslogtreecommitdiff
path: root/examples/turing_machine/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/turing_machine/README.md')
-rw-r--r--examples/turing_machine/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/examples/turing_machine/README.md b/examples/turing_machine/README.md
new file mode 100644
index 0000000..8155871
--- /dev/null
+++ b/examples/turing_machine/README.md
@@ -0,0 +1,14 @@
+# Turing Machine Example
+This directory contains code for simulating a Turing machine with `TSLang`. Its
+primary goal is to demonstrate the use and power of our rewrite rules.
+You can run the example from the root of the Sifter repository like so:
+```bash
+bazel run examples/turing_machine:turing_machine
+```
+It will print the proposed delta, corresponding to one step of the machine's
+execution.
+
+#### Files
+* `turing_machine.py` contains code defining the TM as a triplet structure.
+* `test_turing_machine.py` is a Pytest test which ensures that
+ `turing_machine.py` returns the correct result.
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback