rename "examples" to "demos" to avoid confusion with Cargo examples

I got confused because I tried to run the player with: cargo run --examples demo_player However this did not work because demo_player is structured as a subcrate in a workspace, not as an example. Cargo examples do not have a src directory nor their own Cargo.toml: https://doc.rust-lang.org/cargo/guide/project-layout.html Unfortunately there is no way to specify dependencies only for an example. There is an open RFC for that: rust-lang/rfcs#2887 So for now, I think it is best to leave the demo applications as subcrates in a workspace, but rename the "examples" directory to "demos" so people don't think they will work with cargo run --examples
obsoleszenz · Apr 17, 2022 · 9e60a04 · 9e60a04
1 parent 38d00bd
commit 9e60a04
Show file tree

Hide file tree

Showing 15 changed files with 6 additions and 6 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -21,8 +21,8 @@ members = [
     "core",
     "decode_wav",
     "encode_wav",
-    "examples/demo_player",
-    "examples/demo_writer",
+    "demos/player",
+    "demos/writer",
 ]
 
 [features]

diff --git a/examples/demo_player/Cargo.toml → demos/player/Cargo.toml b/examples/demo_player/Cargo.toml → demos/player/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "demo_player"
+name = "player"
 version = "0.1.0"
 authors = ["Billy Messenger <[email protected]>"]
 edition = "2018"
@@ -11,4 +11,4 @@ publish = false
 creek = { path = "../../" }
 eframe = "0.9.0"
 rtrb = "0.2"
-cpal = "0.13"
+cpal = "0.13"
diff --git a/examples/demo_player/README.md → demos/player/README.md b/examples/demo_player/README.md → demos/player/README.md
diff --git a/examples/demo_player/demo_player.png → demos/player/demo_player.png b/examples/demo_player/demo_player.png → demos/player/demo_player.png
diff --git a/examples/demo_player/src/main.rs → demos/player/src/main.rs b/examples/demo_player/src/main.rs → demos/player/src/main.rs
diff --git a/examples/demo_player/src/output.rs → demos/player/src/output.rs b/examples/demo_player/src/output.rs → demos/player/src/output.rs
diff --git a/examples/demo_player/src/process.rs → demos/player/src/process.rs b/examples/demo_player/src/process.rs → demos/player/src/process.rs
diff --git a/examples/demo_player/src/ui.rs → demos/player/src/ui.rs b/examples/demo_player/src/ui.rs → demos/player/src/ui.rs
diff --git a/examples/demo_writer/Cargo.toml → demos/writer/Cargo.toml b/examples/demo_writer/Cargo.toml → demos/writer/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "demo_writer"
+name = "writer"
 version = "0.1.0"
 authors = ["Billy Messenger <[email protected]>"]
 edition = "2018"
@@ -11,4 +11,4 @@ publish = false
 creek = { path = "../../" }
 eframe = "0.9.0"
 rtrb = "0.2"
-cpal = "0.13"
+cpal = "0.13"
diff --git a/examples/demo_writer/README.md → demos/writer/README.md b/examples/demo_writer/README.md → demos/writer/README.md
diff --git a/examples/demo_writer/demo_writer.png → demos/writer/demo_writer.png b/examples/demo_writer/demo_writer.png → demos/writer/demo_writer.png
diff --git a/examples/demo_writer/src/main.rs → demos/writer/src/main.rs b/examples/demo_writer/src/main.rs → demos/writer/src/main.rs
diff --git a/examples/demo_writer/src/output.rs → demos/writer/src/output.rs b/examples/demo_writer/src/output.rs → demos/writer/src/output.rs
diff --git a/examples/demo_writer/src/process.rs → demos/writer/src/process.rs b/examples/demo_writer/src/process.rs → demos/writer/src/process.rs
diff --git a/examples/demo_writer/src/ui.rs → demos/writer/src/ui.rs b/examples/demo_writer/src/ui.rs → demos/writer/src/ui.rs