aboutsummaryrefslogtreecommitdiff
path: root/spec
diff options
context:
space:
mode:
authorMarshall Lochbaum <mwlochbaum@gmail.com>2020-06-19 08:34:29 -0400
committerMarshall Lochbaum <mwlochbaum@gmail.com>2020-06-19 08:36:18 -0400
commit6adf8fca28b3c7ebdad7153b019d7013cc3ceff7 (patch)
tree721f5f5952a83242f5c3a0087ea0ad1772218c48 /spec
parentc1d06603e2cd402da5ed10a5e7376e9e2fda039d (diff)
Add specification README
Diffstat (limited to 'spec')
-rw-r--r--spec/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/spec/README.md b/spec/README.md
new file mode 100644
index 00000000..eea0b868
--- /dev/null
+++ b/spec/README.md
@@ -0,0 +1,11 @@
+# BQN specification
+
+This directory gives a (currently incomplete) specification for BQN. The specification differs from the documentation in `doc/` in that its purpose is only to describe the exact details of BQN's operation in the most quickly accessible way, rather than to explain the core ideas of BQN functionality and how it might be used. Since it is easier to specify than to document, the specification is currently more complete than the documentation; for example, it includes nearly all primitives.
+
+The following aspects define BQN and are or will be specified:
+- Token formation
+- Numeric and character literals
+- Syntactic class and grammar
+- Array model and notation
+- Evaluation semantics
+- Built-in operations ([reference implementations](reference.bqn))