timw4mail
/
scroll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
Timothy Warren 2023-11-10 21:24:47 -05:00
parent 8bb3018e84
commit bc8d398044
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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`

2
justfile
View File

@ -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: