scroll/README.md
Timothy J. Warren 01b8535c5e
All checks were successful
timw4mail/scroll/pipeline/head This commit looks good
Highlight numbers properly
2024-07-16 11:17:45 -04:00

1.0 KiB

Scroll

Making a text editor in Typescript based on Kilo (Script + Kilo = Scroll). This runs on

  • Bun (v1.0 or later)
  • Deno (v1.37 or later)
  • TSX - this is a Typescript wrapper using NodeJS (v20 or later)

To simplify running, I'm using Just.

  • Bun: just bun-run [filename]
  • Deno: just deno-run [filename]
  • TSX: just tsx-run [filename]

Alternatively, there are shell scripts for each runtime in the bin folder. So you can run the editor by calling ./bin/deno.sh [filename] without installing Just.

Deno is generally used for dev tools, but each runtime should be functionally equivalent running the text editor.

Development Notes

  • Implementation is based on Kilo and Hecto
  • Runtime differences are adapted into a common interface
  • Runtime implementations are in the src/deno, src/bun, src/tsx folders
  • The main implementation is in src/common