aboutsummaryrefslogtreecommitdiff
path: root/doc/README.md
diff options
context:
space:
mode:
authorMarshall Lochbaum <mwlochbaum@gmail.com>2020-07-18 11:01:23 -0400
committerMarshall Lochbaum <mwlochbaum@gmail.com>2020-07-18 11:01:23 -0400
commit920e5f624551f7b63b590cb0d6c0a6366a45fca2 (patch)
tree2141896274ec901d634f4c4d82d1a0e1cf2ba721 /doc/README.md
parent915c912d5c5a645ae268e9088968946e851d5b9e (diff)
Add index for doc/ folder
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 00000000..8636b23c
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,19 @@
+# BQN documentation
+
+Here is the documentation for BQN, describing what features BQN has, how to use them (with examples), and why they were chosen. As it is considerably more in-depth than the [specification](../spec/README.md), the documentation is much less complete. The following pages are present now:
+
+Concepts:
+- [Context-free grammar](context.md)
+- [Functional programming](functional.md)
+- [Array indices](indices.md)
+
+Primitives:
+- [Array depth](depth.md) (`≡` and `⚇`)
+- [Group](group.md) (`⊔`)
+- [Join](join.md) (`∾`)
+- [Logical functions](logic.md) (`∧∨¬`)
+- [Transpose](transpose.md) (`⍉`)
+- [Windows](windows.md) (`↕`)
+
+References:
+- [BQN-Dyalog dictionary](fromDyalog.md)