From 9e60a04cb9c56ed4b1df243561f0f0230a095254 Mon Sep 17 00:00:00 2001 From: Be Date: Wed, 1 Dec 2021 22:40:11 -0600 Subject: [PATCH] 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: https://github.com/rust-lang/rfcs/pull/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 --- Cargo.toml | 4 ++-- {examples/demo_player => demos/player}/Cargo.toml | 4 ++-- {examples/demo_player => demos/player}/README.md | 0 .../demo_player => demos/player}/demo_player.png | Bin {examples/demo_player => demos/player}/src/main.rs | 0 .../demo_player => demos/player}/src/output.rs | 0 .../demo_player => demos/player}/src/process.rs | 0 {examples/demo_player => demos/player}/src/ui.rs | 0 {examples/demo_writer => demos/writer}/Cargo.toml | 4 ++-- {examples/demo_writer => demos/writer}/README.md | 0 .../demo_writer => demos/writer}/demo_writer.png | Bin {examples/demo_writer => demos/writer}/src/main.rs | 0 .../demo_writer => demos/writer}/src/output.rs | 0 .../demo_writer => demos/writer}/src/process.rs | 0 {examples/demo_writer => demos/writer}/src/ui.rs | 0 15 files changed, 6 insertions(+), 6 deletions(-) rename {examples/demo_player => demos/player}/Cargo.toml (89%) rename {examples/demo_player => demos/player}/README.md (100%) rename {examples/demo_player => demos/player}/demo_player.png (100%) rename {examples/demo_player => demos/player}/src/main.rs (100%) rename {examples/demo_player => demos/player}/src/output.rs (100%) rename {examples/demo_player => demos/player}/src/process.rs (100%) rename {examples/demo_player => demos/player}/src/ui.rs (100%) rename {examples/demo_writer => demos/writer}/Cargo.toml (89%) rename {examples/demo_writer => demos/writer}/README.md (100%) rename {examples/demo_writer => demos/writer}/demo_writer.png (100%) rename {examples/demo_writer => demos/writer}/src/main.rs (100%) rename {examples/demo_writer => demos/writer}/src/output.rs (100%) rename {examples/demo_writer => demos/writer}/src/process.rs (100%) rename {examples/demo_writer => demos/writer}/src/ui.rs (100%) diff --git a/Cargo.toml b/Cargo.toml index 54f58e8..e4224c8 100644 --- 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 b/demos/player/Cargo.toml similarity index 89% rename from examples/demo_player/Cargo.toml rename to demos/player/Cargo.toml index a28001a..f685bd9 100644 --- a/examples/demo_player/Cargo.toml +++ b/demos/player/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "demo_player" +name = "player" version = "0.1.0" authors = ["Billy Messenger "] edition = "2018" @@ -11,4 +11,4 @@ publish = false creek = { path = "../../" } eframe = "0.9.0" rtrb = "0.2" -cpal = "0.13" \ No newline at end of file +cpal = "0.13" diff --git a/examples/demo_player/README.md b/demos/player/README.md similarity index 100% rename from examples/demo_player/README.md rename to demos/player/README.md diff --git a/examples/demo_player/demo_player.png b/demos/player/demo_player.png similarity index 100% rename from examples/demo_player/demo_player.png rename to demos/player/demo_player.png diff --git a/examples/demo_player/src/main.rs b/demos/player/src/main.rs similarity index 100% rename from examples/demo_player/src/main.rs rename to demos/player/src/main.rs diff --git a/examples/demo_player/src/output.rs b/demos/player/src/output.rs similarity index 100% rename from examples/demo_player/src/output.rs rename to demos/player/src/output.rs diff --git a/examples/demo_player/src/process.rs b/demos/player/src/process.rs similarity index 100% rename from examples/demo_player/src/process.rs rename to demos/player/src/process.rs diff --git a/examples/demo_player/src/ui.rs b/demos/player/src/ui.rs similarity index 100% rename from examples/demo_player/src/ui.rs rename to demos/player/src/ui.rs diff --git a/examples/demo_writer/Cargo.toml b/demos/writer/Cargo.toml similarity index 89% rename from examples/demo_writer/Cargo.toml rename to demos/writer/Cargo.toml index 6cdc144..e335382 100644 --- a/examples/demo_writer/Cargo.toml +++ b/demos/writer/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "demo_writer" +name = "writer" version = "0.1.0" authors = ["Billy Messenger "] edition = "2018" @@ -11,4 +11,4 @@ publish = false creek = { path = "../../" } eframe = "0.9.0" rtrb = "0.2" -cpal = "0.13" \ No newline at end of file +cpal = "0.13" diff --git a/examples/demo_writer/README.md b/demos/writer/README.md similarity index 100% rename from examples/demo_writer/README.md rename to demos/writer/README.md diff --git a/examples/demo_writer/demo_writer.png b/demos/writer/demo_writer.png similarity index 100% rename from examples/demo_writer/demo_writer.png rename to demos/writer/demo_writer.png diff --git a/examples/demo_writer/src/main.rs b/demos/writer/src/main.rs similarity index 100% rename from examples/demo_writer/src/main.rs rename to demos/writer/src/main.rs diff --git a/examples/demo_writer/src/output.rs b/demos/writer/src/output.rs similarity index 100% rename from examples/demo_writer/src/output.rs rename to demos/writer/src/output.rs diff --git a/examples/demo_writer/src/process.rs b/demos/writer/src/process.rs similarity index 100% rename from examples/demo_writer/src/process.rs rename to demos/writer/src/process.rs diff --git a/examples/demo_writer/src/ui.rs b/demos/writer/src/ui.rs similarity index 100% rename from examples/demo_writer/src/ui.rs rename to demos/writer/src/ui.rs