summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorOwen Jacobson <owen@grimoire.ca>2017-11-08 02:16:50 -0500
committerOwen Jacobson <owen@grimoire.ca>2017-11-08 02:22:04 -0500
commit0fcc2dc618f2eb00d8cf82ce328c98e0ea9f2626 (patch)
treeadabcf3d10a9204cc2adcea16404fe8b13afc16d /README.rst
parentcb4f719cc09ab723acd72df4b727b1740650d87c (diff)
Wrote the tokenizer.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst17
1 files changed, 13 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index fc6d805..1e29ec9 100644
--- a/README.rst
+++ b/README.rst
@@ -42,6 +42,12 @@ fill up RAM, and drain your battery.
.. _lispy: http://norvig.com/lispy.html
************
+Requirements
+************
+
+Actinide requires Python 3.6 or later.
+
+************
Installation
************
@@ -57,10 +63,13 @@ Or, if you prefer, add ``actinide`` to your application's ``Pipfile`` or
Freestanding REPL
*****************
-The Actinide interpreter can be started interactively using the `actinide-repl`
-command. In this mode, Actinide forms can be entered interactively. The REPL
-will immediately evaluate each top-level form, then print the result of that
-evaluation.
+**Note: this section is presently incorrect - the ``actinide-repl`` command
+instead contains a test harness for the tokenizer.**
+
+The Actinide interpreter can be started interactively using the
+``actinide-repl`` command. In this mode, Actinide forms can be entered
+interactively. The REPL will immediately evaluate each top-level form, then
+print the result of that evaluation.
To exit the REPL, type an end-of-file (Ctrl-D on most OSes, Ctrl-Z on Windows).