diff --git a/app/README.md b/app/README.md index bc4e996..b8d2fda 100644 --- a/app/README.md +++ b/app/README.md @@ -1,15 +1,20 @@ # NOSE:pluto -- [x] Hosts valtown-style Bun apps (for your home network) -- [x] Provides a NOSE terminal/shell GUI -- [x] Runs one-shot TypeScript commands (via NOSE terminal) -- [x] Has a 960x540 (16:9) virtual screen size that scales to the actual size of the display -- [x] Runs on a Raspberry Pi 5 +## Installation + +You just need to make a "nose" user on your RPi and make sure you can ssh in. + +Then run `bun deploy && bun remote:install`. + +When it's done (it'll reboot) visit: + + http://nose-pluto.local ## Local Dev bun install bun dev + open localhost:3000 ## Commands @@ -25,4 +30,16 @@ They can also `throw` to display an error. Use this to examine what's inside the C64 .woff2 font file in public/vendor: -https://wakamaifondue.com/ \ No newline at end of file +https://wakamaifondue.com/ + +## Pluto Goals: Phase 1 + +- [x] Hosts valtown-style Bun apps (for your home network) +- [x] Provides a NOSE terminal/shell GUI +- [x] Runs one-shot TypeScript commands (via NOSE terminal) +- [x] Has a 960x540 (16:9) virtual screen size that scales to the actual size of the display +- [x] Runs on a Raspberry Pi 5 + +## Pluto Goals: Phase 2 + +- [ ] coming soon \ No newline at end of file