From 7794606ce3f094bbab4f2d46ece6719d627e4e88 Mon Sep 17 00:00:00 2001 From: Marshall Lochbaum Date: Fri, 27 Nov 2020 16:18:44 -0500 Subject: Add src/ README --- src/README.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 src/README.txt (limited to 'src/README.txt') 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 -- cgit v1.2.3