Reorganize demos into subfolder (#135)

mkeeter · Jun 6, 2024 · 7e33453 · 7e33453
1 parent 0cf551f
commit 7e33453
Show file tree

Hide file tree

Showing 34 changed files with 114 additions and 74 deletions.
diff --git a/.github/workflows/constraints-demo.yml b/.github/workflows/constraints-demo.yml
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: ./constraints
+        working-directory: ./demos/constraints
     steps:
     - uses: actions/checkout@v4
     - uses: Swatinem/rust-cache@v2

diff --git a/.github/workflows/wasm-demo.yml b/.github/workflows/wasm-demo.yml
@@ -14,14 +14,15 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: ./wasm-demo
+        working-directory: ./demos/web-editor
     steps:
     - uses: actions/checkout@v4
     - uses: Swatinem/rust-cache@v2
     - name: Install wasm target
       run: rustup target add wasm32-unknown-unknown
     - name: Install wasm-pack
-      run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
+      run: |
+        curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
     - name: Install npm dependencies
       run: npm install
     - name: Check Prettier

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,12 +2,12 @@
 resolver = "2"
 members = [
     "fidget",
-    "constraints",
-    "demo",
-    "viewer",
+    "demos/constraints",
+    "demos/cli",
+    "demos/viewer",
     "workspace-hack",
 ]
-exclude = ["wasm-demo"]
+exclude = ["demos/web-editor"]
 
 [profile.release]
 debug = true

diff --git a/README.md b/README.md
@@ -51,31 +51,10 @@ Issues and PRs are welcome, although I'm unlikely to merge anything which adds
 substantial maintenance burden.  This is a personal-scale experimental project,
 so adjust your expectations accordingly.
 
-## Demo applications
-In the [repository on Github](https://github.com/mkeeter/fidget), there are
-two demo applications:
-
-- `demo` does bitmap rendering and meshing from the command line
-- `viewer` is a minimal GUI for interactive exploration
-
-These are deliberately not published to [https://crates.io](crates.io), because
-they're demo applications and not complete end-user tools.
-
-## WebAssembly demo
-The `wasm-demo` subfolder embeds Fidget into a web application.  Building this
-demo requires [`wasm-pack`](https://rustwasm.github.io/wasm-pack/)
-to be installed on the host system.
-
-In that folder, run it with
-```
-npm install
-npm run serve
-```
-
-Or bundle files for distribution with
-```
-npm run build
-```
+## Demos
+The [`demos` folder](demos/README.md) contains several demo tools and
+applications built using the Fidget crate,
+ranging from CLI to GUI to web app.
 
 ## Support matrix
 At the moment, Fidget supports a limited number of platforms:

diff --git a/demos/.gitignore b/demos/.gitignore
@@ -0,0 +1 @@
+!*/screenshot.png
diff --git a/demos/README.md b/demos/README.md
@@ -0,0 +1,41 @@
+# Fidget demos
+## Command-line demo ([`cli`](cli/))
+
+Bitmap rendering and meshing from the command line
+```shell
+$ cargo run -pfidget-cli --release -- -i models/prospero.vm render2d -s512 --eval=vm -oout.png
+    Finished release [optimized + debuginfo] target(s) in 0.07s
+     Running `target/release/fidget-cli -i models/prospero.vm render2d -s512 --eval=vm -oout.png`
+[2024-06-06T16:08:12Z INFO  fidget_cli] Loaded file in 4.528208ms
+[2024-06-06T16:08:12Z INFO  fidget_cli] Built shape in 2.375208ms
+[2024-06-06T16:08:12Z INFO  fidget_cli] Rendered 1x at 14.489 ms/frame
+```
+
+## Script viewer ([`viewer`](viewer/))
+Minimal desktop GUI for interactive exploration,
+using [`egui`](https://github.com/emilk/egui)
+
+```shell
+cargo run --release -pfidget-viewer
+```
+
+![screenshot of script viewer](viewer/screenshot.png)
+
+## Constraint solving ([`constraints`](constraints/))
+Example of using Fidget for constraint solving.
+Uses [`egui`](https://github.com/emilk/egui)
+and runs either on the desktop or as a web app.
+```shell
+cargo run --release -pconstraints
+```
+
+![screenshot of contraint editor](constraints/screenshot.png)
+
+See the [subfolder](constraints/) for details on bundling for the web.
+
+## Web-based editor ([`web-editor`](web-editor/))
+Integrates Fidget into a TypeScript project (web only)
+
+![screenshot of web editor](web-editor/screenshot.png)
+
+See the [subfolder](web-editor/) for details on bundling for the web.
diff --git a/demo/Cargo.toml → demos/cli/Cargo.toml b/demo/Cargo.toml → demos/cli/Cargo.toml
@@ -1,18 +1,18 @@
 [package]
-name = "demo"
+name = "fidget-cli"
 version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-fidget = { path = "../fidget", default-features = false, features = ["render", "mesh"] }
+fidget = { path = "../../fidget", default-features = false, features = ["render", "mesh"] }
 
 anyhow = "1"
 clap = { version = "4", features = ["derive"] }
 env_logger = "0.11.2"
 image = { version = "0.24", default-features = false, features = ["png"] }
 log = "0.4"
 nalgebra = "0.31"
-workspace-hack = { version = "0.1", path = "../workspace-hack" }
+workspace-hack = { version = "0.1", path = "../../workspace-hack" }
 
 [features]
 jit = ["fidget/jit"]

diff --git a/demo/src/main.rs → demos/cli/src/main.rs b/demo/src/main.rs → demos/cli/src/main.rs
diff --git a/constraints/.gitignore → demos/constraints/.gitignore b/constraints/.gitignore → demos/constraints/.gitignore
diff --git a/constraints/Cargo.toml → demos/constraints/Cargo.toml b/constraints/Cargo.toml → demos/constraints/Cargo.toml
@@ -10,9 +10,9 @@ eframe = { version = "0.27", default-features = false, features = [
     "glow",          # Use the glow rendering backend. Alternative: "wgpu".
 ] }
 
-fidget = { path = "../fidget", default-features = false, features = ["solver"] }
+fidget = { path = "../../fidget", default-features = false, features = ["solver"] }
 log = "0.4"
-workspace-hack = { version = "0.1", path = "../workspace-hack" }
+workspace-hack = { version = "0.1", path = "../../workspace-hack" }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 env_logger = "0.10.0"

diff --git a/constraints/README.md → demos/constraints/README.md b/constraints/README.md → demos/constraints/README.md
@@ -1,8 +1,9 @@
 # Demo of constraint solving
 ## WebAssembly
 ### Setup
+Install the [`trunk`](https://trunkrs.dev/) bundler with
 ```
-cargon install +locked trunk # installs the `trunk` bundler
+cargo install +locked trunk
 ```
 ### Developing
 In this folder, run

diff --git a/constraints/index.html → demos/constraints/index.html b/constraints/index.html → demos/constraints/index.html
diff --git a/demos/constraints/screenshot.png b/demos/constraints/screenshot.png
diff --git a/constraints/src/main.rs → demos/constraints/src/main.rs b/constraints/src/main.rs → demos/constraints/src/main.rs
diff --git a/viewer/Cargo.toml → demos/viewer/Cargo.toml b/viewer/Cargo.toml → demos/viewer/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "viewer"
+name = "fidget-viewer"
 version = "0.1.0"
 edition = "2021"
 
@@ -15,12 +15,12 @@ eframe = { version = "0.27", default-features = false, features = [
 ] }
 env_logger = "0.10.0"
 
-fidget = { path = "../fidget", default-features = false, features = ["render", "rhai"] }
+fidget = { path = "../../fidget", default-features = false, features = ["render", "rhai"] }
 log = "0.4"
 nalgebra = "0.31"
 notify = "5.0"
 rhai = "1.10"
-workspace-hack = { version = "0.1", path = "../workspace-hack" }
+workspace-hack = { version = "0.1", path = "../../workspace-hack" }
 
 [features]
 default = ["jit"]

diff --git a/demos/viewer/screenshot.png b/demos/viewer/screenshot.png
diff --git a/viewer/src/main.rs → demos/viewer/src/main.rs b/viewer/src/main.rs → demos/viewer/src/main.rs
diff --git a/wasm-demo/.gitignore → demos/web-editor/.gitignore b/wasm-demo/.gitignore → demos/web-editor/.gitignore
diff --git a/wasm-demo/Cargo.lock → demos/web-editor/Cargo.lock b/wasm-demo/Cargo.lock → demos/web-editor/Cargo.lock
diff --git a/wasm-demo/Cargo.toml → demos/web-editor/Cargo.toml b/wasm-demo/Cargo.toml → demos/web-editor/Cargo.toml
@@ -8,7 +8,7 @@ crate-type = ["cdylib"]
 
 [dependencies]
 bincode = "1.3.3"
-fidget = {path = "../fidget", default-features = false, features = ["rhai", "mesh", "render"]}
+fidget = {path = "../../fidget", default-features = false, features = ["rhai", "mesh", "render"]}
 wasm-bindgen = "0.2.92"
 nalgebra = "0.31"
 

diff --git a/demos/web-editor/README.md b/demos/web-editor/README.md
@@ -0,0 +1,17 @@
+The `web-editor` subfolder embeds Fidget into a web application.
+
+Building this demo requires [`wasm-pack`](https://rustwasm.github.io/wasm-pack/)
+to be installed on the host system.
+
+Run the editor demo with
+
+```
+npm install
+npm run serve
+```
+
+Or bundle files for distribution with
+
+```
+npm run build
+```
diff --git a/wasm-demo/constants.ts → demos/web-editor/constants.ts b/wasm-demo/constants.ts → demos/web-editor/constants.ts
diff --git a/wasm-demo/index.html → demos/web-editor/index.html b/wasm-demo/index.html → demos/web-editor/index.html
diff --git a/wasm-demo/index.ts → demos/web-editor/index.ts b/wasm-demo/index.ts → demos/web-editor/index.ts
diff --git a/wasm-demo/message.ts → demos/web-editor/message.ts b/wasm-demo/message.ts → demos/web-editor/message.ts
diff --git a/wasm-demo/package-lock.json → demos/web-editor/package-lock.json b/wasm-demo/package-lock.json → demos/web-editor/package-lock.json
diff --git a/wasm-demo/package.json → demos/web-editor/package.json b/wasm-demo/package.json → demos/web-editor/package.json
diff --git a/demos/web-editor/screenshot.png b/demos/web-editor/screenshot.png
diff --git a/wasm-demo/src/lib.rs → demos/web-editor/src/lib.rs b/wasm-demo/src/lib.rs → demos/web-editor/src/lib.rs
diff --git a/wasm-demo/tsconfig.json → demos/web-editor/tsconfig.json b/wasm-demo/tsconfig.json → demos/web-editor/tsconfig.json
diff --git a/wasm-demo/webpack.config.js → demos/web-editor/webpack.config.js b/wasm-demo/webpack.config.js → demos/web-editor/webpack.config.js
diff --git a/wasm-demo/worker.ts → demos/web-editor/worker.ts b/wasm-demo/worker.ts → demos/web-editor/worker.ts
diff --git a/fidget/src/rhai/core.rhai b/fidget/src/rhai/core.rhai
@@ -25,7 +25,7 @@ fn intersection(a, b) {
 }
 
 fn inverse(a) {
-    a.neg()
+    -a
 }
 
 fn difference(a, b) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,7 +25,7 @@ fn intersection(a, b) { @@
     }
     fn inverse(a) {
-        a.neg()
+        -a
     }
     fn difference(a, b) {
@@ Expand Down @@