diff options
| author | Marshall Lochbaum <mwlochbaum@gmail.com> | 2020-11-27 16:18:44 -0500 |
|---|---|---|
| committer | Marshall Lochbaum <mwlochbaum@gmail.com> | 2020-11-27 16:18:44 -0500 |
| commit | 7794606ce3f094bbab4f2d46ece6719d627e4e88 (patch) | |
| tree | 590ec8a3bb69204e11137cfa2cd896107ec7a77f /src | |
| parent | 4db82b44328828a3a0e72d8bd0c82eeefe8c1c5e (diff) | |
Add src/ README
Diffstat (limited to 'src')
| -rw-r--r-- | src/README.txt | 15 |
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 |