From bc8d3980447f9774322a15656d240a50d9112d1f Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Fri, 10 Nov 2023 21:24:47 -0500 Subject: [PATCH] Update README --- README.md | 12 ++++++++++-- justfile | 2 +- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eed6161..975fd77 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # Scroll -Making a text editor in Typescript based on Kilo (Script + Kilo = Scroll) +Making a text editor in Typescript based on Kilo (Script + Kilo = Scroll). +This runs on [Bun](https://bun.sh/) and [Deno](https://deno.com/). -Having to compile for Node sucks, so targeting Bun and Deno as runtimes +To simplify running, I'm using [Just](https://github.com/casey/just) +* Bun: `just bun-run` +* Deno: `just deno-run` + +## Development Notes +* Runtime differences are adapted into a common interface +* Runtime implementations are in the `src/deno` and `src/bun` folders +* The main implementation is in `src/common` \ No newline at end of file diff --git a/justfile b/justfile index eafedf4..429397a 100644 --- a/justfile +++ b/justfile @@ -6,7 +6,7 @@ default: check: deno-check bun-check docs: - deno doc --html --unstable-ffi --private --name="Scroll" ./src/common/mod.ts + deno doc --html --unstable-ffi --name="Scroll" ./src/scroll.ts ./src/common/mod.ts ./src/deno/mod.ts ./src/bun/mod.ts # Reformat the code fmt: