diff options
| author | Marshall Lochbaum <mwlochbaum@gmail.com> | 2022-07-16 18:43:19 -0400 |
|---|---|---|
| committer | Marshall Lochbaum <mwlochbaum@gmail.com> | 2022-07-16 18:43:19 -0400 |
| commit | 7f9e6c16790ef76f0a197a6f87ecd66bbe64ba09 (patch) | |
| tree | 7b46a4f64ee09c2daaf4c315b9bed4874b814ff4 /.github | |
| parent | 4ee2a8ea9efa633a16c7a7dc2e1f4591afbf540b (diff) | |
Change doc generation instructions to use gendocs, never md.bqn
Diffstat (limited to '.github')
| -rw-r--r-- | .github/contributing.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/.github/contributing.md b/.github/contributing.md index e69c9b41..41a8e716 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -4,10 +4,10 @@ If you have [CBQN](https://github.com/dzaima/CBQN) installed as `bqn` somewhere $ ./gendocs [file.md...] -If no files are given, this builds all docs. It's a thin wrapper around `md.bqn`, and the following version lets you run without the shell path set up: +If no files are given, this builds all docs. It's a BQN script, so the following version lets you run without the shell path set up: - $ /path/to/BQN md.bqn file.md... + $ /path/to/BQN gendocs file.md... With Node.js but no CBQN, you can also run JS BQN, which takes somewhere around 5 seconds plus 1-10 seconds per file. - $ ./bqn.js md.bqn file.md... + $ ./bqn.js gendocs file.md... |