aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/README.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/README.txt b/src/README.txt
new file mode 100644
index 00000000..2881a572
--- /dev/null
+++ b/src/README.txt
@@ -0,0 +1,15 @@
+Documentation for BQN's implementation is at ../implementation/.
+
+BQN sources for BQN. Object code obtained from these sources is run with
+a VM to obtain a BQN implementation. This is done in Javascript in
+../docs/bqn.js and ../docs/repl.js.
+
+- c.bqn Compiler
+- r.bqn Runtime
+- f.bqn Formatter
+- e.bqn Expression syntax explainer
+
+Helper code used to obtain Javascript-formatted object code:
+
+- pr.bqn Preprocess the runtime
+- cjs.bqn Format compiler output as Javascript literals