diff --git a/README.md b/README.md index 6f45a5b..d248a7f 100644 --- a/README.md +++ b/README.md @@ -248,3 +248,54 @@ same as `dev` does in your terminal. We use `deno`, so either install that or—you know—type `dev`. Edit [./src/sniff.ts](src/sniff.ts) to add new dev types. + +### Running your fork locally + +`./app.ts` is a `deno` script with a shebang, so once you’ve cloned the repo you +can invoke it directly: + +```sh +$ ./app.ts --version +dev 0.0.0+dev +``` + +To test changes as your daily-driver `dev` you need to make the shellcode it +generates embed _your_ local script. Two gotchas to be aware of: + +1. **Symlinking `app.ts` directly breaks `deno.json` resolution.** Deno looks + for `deno.json` next to the script path it’s actually invoked as, and doesn’t + follow symlinks. Use a thin shell wrapper instead: + + ```sh + cat > ~/.local/bin/dev <