From daccac26bb217f716bd865c1b224eae6a2ea82ba Mon Sep 17 00:00:00 2001 From: Jonathan Johnson Date: Sun, 12 May 2024 08:12:24 -0700 Subject: [PATCH] Adding theme editor screenshot to readme --- .crate-docs.md | 7 ++++++- .rustme/docs.md | 7 ++++++- README.md | 7 ++++++- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/.crate-docs.md b/.crate-docs.md index 56e6bfd..0750496 100644 --- a/.crate-docs.md +++ b/.crate-docs.md @@ -53,7 +53,11 @@ fn main() -> cushy::Result { Here are some ways to learn more about Cushy: - Explore the [examples directory][examples]. Nearly every feature in Cushy was -initially tested by creating an example. +initially tested by creating an example. Many are focused on demonstrating a +single feature, but there are some complex example such as a theme +editor/previewer: + + [![Theme Editor Example](https://cushy.rs/main/guide/examples/theme_editor.png)][theme-example] - Browse the [user's guide][guide]. The user guide is a work in progress, but features CI-generated screenshots and animations for its examples: @@ -77,6 +81,7 @@ Cushy. [widgets]: mod@crate::widgets [button-example]: https://github.com/khonsulabs/cushy/tree/main/examples/basic-button.rs [examples]: https://github.com/khonsulabs/cushy/tree/main/examples/ +[theme-example]: https://github.com/khonsulabs/cushy/tree/main/examples/theme.rs [kludgine]: https://github.com/khonsulabs/kludgine [figures]: https://github.com/khonsulabs/figures [wgpu]: https://github.com/gfx-rs/wgpu diff --git a/.rustme/docs.md b/.rustme/docs.md index 0606249..36eb16d 100644 --- a/.rustme/docs.md +++ b/.rustme/docs.md @@ -40,7 +40,11 @@ $../examples/basic-button.rs:readme$ Here are some ways to learn more about Cushy: - Explore the [examples directory][examples]. Nearly every feature in Cushy was -initially tested by creating an example. +initially tested by creating an example. Many are focused on demonstrating a +single feature, but there are some complex example such as a theme +editor/previewer: + + [![Theme Editor Example](https://cushy.rs/main/guide/examples/theme_editor.png)][theme-example] - Browse the [user's guide][guide]. The user guide is a work in progress, but features CI-generated screenshots and animations for its examples: @@ -64,6 +68,7 @@ Cushy. [widgets]: $widgets$ [button-example]: https://github.com/khonsulabs/cushy/tree/$ref-name$/examples/basic-button.rs [examples]: https://github.com/khonsulabs/cushy/tree/$ref-name$/examples/ +[theme-example]: https://github.com/khonsulabs/cushy/tree/$ref-name$/examples/theme.rs [kludgine]: https://github.com/khonsulabs/kludgine [figures]: https://github.com/khonsulabs/figures [wgpu]: https://github.com/gfx-rs/wgpu diff --git a/README.md b/README.md index 1fec799..7100d45 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,11 @@ fn main() -> cushy::Result { Here are some ways to learn more about Cushy: - Explore the [examples directory][examples]. Nearly every feature in Cushy was -initially tested by creating an example. +initially tested by creating an example. Many are focused on demonstrating a +single feature, but there are some complex example such as a theme +editor/previewer: + + [![Theme Editor Example](https://cushy.rs/main/guide/examples/theme_editor.png)][theme-example] - Browse the [user's guide][guide]. The user guide is a work in progress, but features CI-generated screenshots and animations for its examples: @@ -79,6 +83,7 @@ Cushy. [widgets]: https://cushy.rs/main/docs/cushy/widgets/index.html [button-example]: https://github.com/khonsulabs/cushy/tree/main/examples/basic-button.rs [examples]: https://github.com/khonsulabs/cushy/tree/main/examples/ +[theme-example]: https://github.com/khonsulabs/cushy/tree/main/examples/theme.rs [kludgine]: https://github.com/khonsulabs/kludgine [figures]: https://github.com/khonsulabs/figures [wgpu]: https://github.com/gfx-rs/wgpu