update, build for nw.js app

insanj · Apr 3, 2022 · 9082aae · 9082aae
1 parent 1f5a66d
commit 9082aae
Show file tree

Hide file tree

Showing 5 changed files with 4,885 additions and 449 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,6 @@
 .DS_Store
+nwjs/
+dist/
 
 # Logs
 logs

diff --git a/README.md b/README.md
@@ -1,8 +1,23 @@
 # sammy
-🥪  d2c immersive 3d sandwich printer
+
+🥪 d2c immersive 3d sandwich printer (prev `sammy.best`)
+
+d2c immersive 3d sandwich printer. weekend project using three.js and some other nifty tools to create an immersive web browser experience.
+
+was a progressive web app built to let you spin around a 3d model and take it apart using your keyboard. music played that corresponded to each ingredient in the sandwich. was an April Fools-type joke!
 
 <img src="https://user-images.githubusercontent.com/951011/103191164-e858cb80-48a1-11eb-838c-f08171d04914.png" width="50%" />
 
+## Usage
+
+No longer live as a PWA. Now, you an install as a tiny NW.js app.
+
+[Download from Releases page.](https://github.com/insanj/sammy/releases)
+
+1. Download [NW.js](https://nwjs.io/), currently using `v0.61.0`, place in a folder called `nwjs/` within this repo
+2. `npm install`
+3. `npm start` or `npm mac`/`npm win`/`npm lin`
+
 ## Authors
 
 ```