diff --git a/packages/cli/README.md b/packages/cli/README.md index 7b0d0038..cecbb841 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -20,3 +20,30 @@ Runs compilation in the current directory and all of its subdirectories. ### `npx squiggle-cli-experimental watch` Watches `.squiggleU` files in the current directory (and subdirectories) and rebuilds them when they are saved. Note that this will _not_ rebuild files when their dependencies are changed, just when they are changed directly. + +## Further instructions + +The above requires having node, npm and npx. To install the first two, see [here](https://nodejs.org/en/), to install npx, run: + +``` +npm install -g npx +``` + +Alternatively, you can run the following without the need for npx: + +``` +npm install squiggle-cli-experimental +node node_modules/squiggle-cli-experimental/index.js compile +``` + +or you can add a script to your `package.json`, like: + +```` + ... + scripts: { + "compile": "squiggle-cli-experimental compile" + } + ... +```` + +This can be run with `npm run compile`. `npm` knows how to reach into the node_modules directly, so it's not necessary to specify that.