From 35eba76b4dff047dde2d1e01bc427eb1b992b490 Mon Sep 17 00:00:00 2001 From: Josh McKinney Date: Sun, 1 Dec 2024 02:46:26 -0800 Subject: [PATCH] chore(example): move demo2 to top level folder (#1524) --- Cargo.lock | 21 +++++++++++++++++-- examples/README.md | 6 ++++++ examples/apps/demo/Cargo.toml | 8 ------- examples/apps/demo2/Cargo.toml | 19 +++++++++++++++++ examples/apps/demo2/README.md | 9 ++++++++ .../demo2 => examples/apps/demo2/src}/app.rs | 0 .../apps/demo2/src}/colors.rs | 0 .../apps/demo2/src}/destroy.rs | 0 .../demo2 => examples/apps/demo2/src}/main.rs | 0 .../demo2 => examples/apps/demo2/src}/tabs.rs | 0 .../apps/demo2/src}/tabs/about.rs | 0 .../apps/demo2/src}/tabs/email.rs | 0 .../apps/demo2/src}/tabs/recipe.rs | 0 .../apps/demo2/src}/tabs/traceroute.rs | 0 .../apps/demo2/src}/tabs/weather.rs | 0 .../apps/demo2/src}/theme.rs | 0 ratatui/Cargo.toml | 6 ------ ratatui/examples/README.md | 11 ---------- 18 files changed, 53 insertions(+), 27 deletions(-) create mode 100644 examples/apps/demo2/Cargo.toml create mode 100644 examples/apps/demo2/README.md rename {ratatui/examples/demo2 => examples/apps/demo2/src}/app.rs (100%) rename {ratatui/examples/demo2 => examples/apps/demo2/src}/colors.rs (100%) rename {ratatui/examples/demo2 => examples/apps/demo2/src}/destroy.rs (100%) rename {ratatui/examples/demo2 => examples/apps/demo2/src}/main.rs (100%) rename {ratatui/examples/demo2 => examples/apps/demo2/src}/tabs.rs (100%) rename {ratatui/examples/demo2 => examples/apps/demo2/src}/tabs/about.rs (100%) rename {ratatui/examples/demo2 => examples/apps/demo2/src}/tabs/email.rs (100%) rename {ratatui/examples/demo2 => examples/apps/demo2/src}/tabs/recipe.rs (100%) rename {ratatui/examples/demo2 => examples/apps/demo2/src}/tabs/traceroute.rs (100%) rename {ratatui/examples/demo2 => examples/apps/demo2/src}/tabs/weather.rs (100%) rename {ratatui/examples/demo2 => examples/apps/demo2/src}/theme.rs (100%) diff --git a/Cargo.lock b/Cargo.lock index 5d50a93d..ab95edda 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -730,6 +730,23 @@ dependencies = [ "ratatui", ] +[[package]] +name = "demo2" +version = "0.0.0" +dependencies = [ + "color-eyre", + "crossterm", + "indoc", + "itertools 0.13.0", + "palette", + "rand 0.8.5", + "rand_chacha 0.3.1", + "ratatui", + "strum", + "time", + "unicode-width", +] + [[package]] name = "deranged" version = "0.3.11" @@ -1393,9 +1410,9 @@ checksum = "ce23b50ad8242c51a442f3ff322d56b02f08852c77e4c0b4d3fd684abc89c683" [[package]] name = "indexmap" -version = "2.6.0" +version = "2.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "707907fe3c25f5424cce2cb7e1cbcafee6bdbe735ca90ef77c29e84591e5b9da" +checksum = "62f822373a4fe84d4bb149bf54e584a7f4abec90e072ed49cda0edea5b95471f" dependencies = [ "equivalent", "hashbrown", diff --git a/examples/README.md b/examples/README.md index fc8ea4ef..218bbb6e 100644 --- a/examples/README.md +++ b/examples/README.md @@ -42,3 +42,9 @@ This is the original demo example from the main README. It is available for each [Source](./apps/demo/). ![Demo](https://github.com/ratatui/ratatui/blob/images/examples/demo.gif?raw=true) + +## Demo2 + +This is the demo example from the main README and crate page. [Source](./apps/demo2/). + +![Demo2](https://github.com/ratatui/ratatui/blob/images/examples/demo2.gif?raw=true) diff --git a/examples/apps/demo/Cargo.toml b/examples/apps/demo/Cargo.toml index 5505b62c..a9742eb3 100644 --- a/examples/apps/demo/Cargo.toml +++ b/examples/apps/demo/Cargo.toml @@ -1,15 +1,7 @@ [package] name = "demo" publish = false -authors.workspace = true -documentation.workspace = true -repository.workspace = true -homepage.workspace = true -keywords.workspace = true -categories.workspace = true -readme.workspace = true license.workspace = true -exclude.workspace = true edition.workspace = true rust-version.workspace = true diff --git a/examples/apps/demo2/Cargo.toml b/examples/apps/demo2/Cargo.toml new file mode 100644 index 00000000..4c8e3096 --- /dev/null +++ b/examples/apps/demo2/Cargo.toml @@ -0,0 +1,19 @@ +[package] +name = "demo2" +publish = false +license.workspace = true +edition.workspace = true +rust-version.workspace = true + +[dependencies] +color-eyre = "0.6.3" +crossterm.workspace = true +indoc.workspace = true +itertools.workspace = true +palette = "0.7.6" +rand = "0.8.5" +rand_chacha = "0.3.1" +ratatui = { workspace = true, features = ["all-widgets"] } +strum.workspace = true +time = "0.3.36" +unicode-width = "0.2.0" diff --git a/examples/apps/demo2/README.md b/examples/apps/demo2/README.md new file mode 100644 index 00000000..7c6be555 --- /dev/null +++ b/examples/apps/demo2/README.md @@ -0,0 +1,9 @@ +## Demo2 + +This is the demo example from the main README and crate page. Source: [demo2](./demo2/). + +```shell +cargo run -p demo2 +``` + +![Demo2](https://github.com/ratatui/ratatui/blob/images/examples/demo2.gif?raw=true) diff --git a/ratatui/examples/demo2/app.rs b/examples/apps/demo2/src/app.rs similarity index 100% rename from ratatui/examples/demo2/app.rs rename to examples/apps/demo2/src/app.rs diff --git a/ratatui/examples/demo2/colors.rs b/examples/apps/demo2/src/colors.rs similarity index 100% rename from ratatui/examples/demo2/colors.rs rename to examples/apps/demo2/src/colors.rs diff --git a/ratatui/examples/demo2/destroy.rs b/examples/apps/demo2/src/destroy.rs similarity index 100% rename from ratatui/examples/demo2/destroy.rs rename to examples/apps/demo2/src/destroy.rs diff --git a/ratatui/examples/demo2/main.rs b/examples/apps/demo2/src/main.rs similarity index 100% rename from ratatui/examples/demo2/main.rs rename to examples/apps/demo2/src/main.rs diff --git a/ratatui/examples/demo2/tabs.rs b/examples/apps/demo2/src/tabs.rs similarity index 100% rename from ratatui/examples/demo2/tabs.rs rename to examples/apps/demo2/src/tabs.rs diff --git a/ratatui/examples/demo2/tabs/about.rs b/examples/apps/demo2/src/tabs/about.rs similarity index 100% rename from ratatui/examples/demo2/tabs/about.rs rename to examples/apps/demo2/src/tabs/about.rs diff --git a/ratatui/examples/demo2/tabs/email.rs b/examples/apps/demo2/src/tabs/email.rs similarity index 100% rename from ratatui/examples/demo2/tabs/email.rs rename to examples/apps/demo2/src/tabs/email.rs diff --git a/ratatui/examples/demo2/tabs/recipe.rs b/examples/apps/demo2/src/tabs/recipe.rs similarity index 100% rename from ratatui/examples/demo2/tabs/recipe.rs rename to examples/apps/demo2/src/tabs/recipe.rs diff --git a/ratatui/examples/demo2/tabs/traceroute.rs b/examples/apps/demo2/src/tabs/traceroute.rs similarity index 100% rename from ratatui/examples/demo2/tabs/traceroute.rs rename to examples/apps/demo2/src/tabs/traceroute.rs diff --git a/ratatui/examples/demo2/tabs/weather.rs b/examples/apps/demo2/src/tabs/weather.rs similarity index 100% rename from ratatui/examples/demo2/tabs/weather.rs rename to examples/apps/demo2/src/tabs/weather.rs diff --git a/ratatui/examples/demo2/theme.rs b/examples/apps/demo2/src/theme.rs similarity index 100% rename from ratatui/examples/demo2/theme.rs rename to examples/apps/demo2/src/theme.rs diff --git a/ratatui/Cargo.toml b/ratatui/Cargo.toml index 66bd09b8..f79c0099 100644 --- a/ratatui/Cargo.toml +++ b/ratatui/Cargo.toml @@ -97,7 +97,6 @@ unstable-backend-writer = [ [dependencies] document-features = { workspace = true, optional = true } -indoc = "2" instability.workspace = true itertools.workspace = true palette = { version = "0.7.6", optional = true } @@ -200,11 +199,6 @@ name = "custom_widget" required-features = ["crossterm"] doc-scrape-examples = true -[[example]] -name = "demo2" -required-features = ["crossterm", "palette", "widget-calendar"] -doc-scrape-examples = true - [[example]] name = "docsrs" required-features = ["crossterm"] diff --git a/ratatui/examples/README.md b/ratatui/examples/README.md index 2f3c6a88..fe60f760 100644 --- a/ratatui/examples/README.md +++ b/ratatui/examples/README.md @@ -43,16 +43,6 @@ move some of these design choices into the core of Ratatui to simplify apps. [How to use color-eyre with Ratatui]: https://ratatui.rs/how-to/develop-apps/color_eyre/ -## Demo2 - -This is the demo example from the main README and crate page. Source: [demo2](./demo2/). - -```shell -cargo run --example=demo2 --features="crossterm widget-calendar" -``` - -![Demo2][demo2.gif] - ## Demo This is the previous demo example from the main README. It is available for each of the backends. Source: @@ -452,7 +442,6 @@ examples/vhs/generate.bash [constraints.gif]: https://github.com/ratatui/ratatui/blob/images/examples/constraints.gif?raw=true [custom_widget.gif]: https://github.com/ratatui/ratatui/blob/images/examples/custom_widget.gif?raw=true [demo.gif]: https://github.com/ratatui/ratatui/blob/images/examples/demo.gif?raw=true -[demo2.gif]: https://github.com/ratatui/ratatui/blob/images/examples/demo2.gif?raw=true [flex.gif]: https://github.com/ratatui/ratatui/blob/images/examples/flex.gif?raw=true [gauge.gif]: https://github.com/ratatui/ratatui/blob/images/examples/gauge.gif?raw=true [hello_world.gif]: https://github.com/ratatui/ratatui/blob/images/examples/hello_world.gif?raw=true