dan/cushy
1
0
Fork 0
mirror of https://github.com/danbulant/cushy synced 2026-07-06 03:30:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Linking to user guide

Browse source
This commit is contained in:
Jonathan Johnson 2024-01-09 06:56:59 -08:00
parent 93775bc542
commit b5bd69136a
No known key found for this signature in database
GPG key ID: A66D6A34D6620579
4 changed files with 38 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
.crate-docs.md
View file

@ -1,6 +1,7 @@
![Cushy is considered alpha and unsupported](https://img.shields.io/badge/status-alpha-orange) ![Cushy is considered alpha and unsupported](https://img.shields.io/badge/status-alpha-orange)
[![crate version](https://img.shields.io/crates/v/cushy.svg)](https://crates.io/crates/cushy) [![crate version](https://img.shields.io/crates/v/cushy.svg)](https://crates.io/crates/cushy)
[![Documentation for `main` branch](https://img.shields.io/badge/docs-main-informational)](https://khonsu.dev/cushy/main/docs/cushy/) [![Documentation for `main`](https://img.shields.io/badge/docs-main-informational)](https://cushy.rs/main/docs/cushy/)
[![Cushy User's Guide](https://img.shields.io/badge/user%27s%20guide-main-informational)][guide]
Cushy is an experimental Graphical User Interface (GUI) crate for the Rust Cushy is an experimental Graphical User Interface (GUI) crate for the Rust
programming language. It features a reactive data model and aims to enable programming language. It features a reactive data model and aims to enable
@ -46,9 +47,12 @@ fn main() -> cushy::Result {
} }
``` ```
A great way to learn more about Cushy is to explore the [examples Here are some ways to learn more about Cushy:
directory][examples]. Nearly every feature in Cushy was initially tested by
creating an example. - Explore the [examples directory][examples]. Nearly every feature in Cushy was
initially tested by creating an example.
- Browse the [user's guide][guide].
- Ask questions [in Discussions][discussions] or [on Discord][discord].
## Project Status ## Project Status
@ -76,6 +80,9 @@ Cushy.
[arboard]: https://github.com/1Password/arboard [arboard]: https://github.com/1Password/arboard
[ecton]: https://github.com/khonsulabs/ecton [ecton]: https://github.com/khonsulabs/ecton
[issues]: https://github.com/khonsulabs/cushy/issues [issues]: https://github.com/khonsulabs/cushy/issues
[guide]: https://cushy.rs/main/guide/
[discussions]: https://github.com/khonsulabs/cushy/discussions
[discord]: https://discord.khonsulabs.com/
## Open-source Licenses ## Open-source Licenses

6
.rustme/config.ron
View file

@ -37,16 +37,16 @@ Configuration(
release: "v0.2.0", release: "v0.2.0",
), ),
"docs": ( "docs": (
default: "https://khonsu.dev/cushy/main/docs/cushy/", default: "https://cushy.rs/main/docs/cushy/",
release: "https://docs.rs/cushy", release: "https://docs.rs/cushy",
), ),
"widget": ( "widget": (
default: "https://khonsu.dev/cushy/main/docs/cushy/widget/trait.Widget.html", default: "https://cushy.rs/main/docs/cushy/widget/trait.Widget.html",
release: "https://docs.rs/cushy/*/cushy/widget/trait.Widget.html", release: "https://docs.rs/cushy/*/cushy/widget/trait.Widget.html",
for_docs: "crate::widget::Widget", for_docs: "crate::widget::Widget",
), ),
"widgets": ( "widgets": (
default: "https://khonsu.dev/cushy/main/docs/cushy/widgets/index.html", default: "https://cushy.rs/main/docs/cushy/widgets/index.html",
release: "https://docs.rs/cushy/*/cushy/widgets/index.html", release: "https://docs.rs/cushy/*/cushy/widgets/index.html",
for_docs: "mod@crate::widgets", for_docs: "mod@crate::widgets",
), ),

15
.rustme/docs.md
View file

@ -1,6 +1,7 @@
![Cushy is considered alpha and unsupported](https://img.shields.io/badge/status-alpha-orange) ![Cushy is considered alpha and unsupported](https://img.shields.io/badge/status-alpha-orange)
[![crate version](https://img.shields.io/crates/v/cushy.svg)](https://crates.io/crates/cushy) [![crate version](https://img.shields.io/crates/v/cushy.svg)](https://crates.io/crates/cushy)
[![Documentation for `main` branch](https://img.shields.io/badge/docs-main-informational)]($docs$) [![Documentation for `$ref-name$`](https://img.shields.io/badge/docs-$ref-name$-informational)]($docs$)
[![Cushy User's Guide](https://img.shields.io/badge/user%27s%20guide-$ref-name$-informational)][guide]
Cushy is an experimental Graphical User Interface (GUI) crate for the Rust Cushy is an experimental Graphical User Interface (GUI) crate for the Rust
programming language. It features a reactive data model and aims to enable programming language. It features a reactive data model and aims to enable
@ -33,9 +34,12 @@ increments its own label:
$../examples/basic-button.rs:readme$ $../examples/basic-button.rs:readme$
``` ```
A great way to learn more about Cushy is to explore the [examples Here are some ways to learn more about Cushy:
directory][examples]. Nearly every feature in Cushy was initially tested by
creating an example. - Explore the [examples directory][examples]. Nearly every feature in Cushy was
initially tested by creating an example.
- Browse the [user's guide][guide].
- Ask questions [in Discussions][discussions] or [on Discord][discord].
## Project Status ## Project Status
@ -63,3 +67,6 @@ Cushy.
[arboard]: https://github.com/1Password/arboard [arboard]: https://github.com/1Password/arboard
[ecton]: https://github.com/khonsulabs/ecton [ecton]: https://github.com/khonsulabs/ecton
[issues]: https://github.com/khonsulabs/cushy/issues [issues]: https://github.com/khonsulabs/cushy/issues
[guide]: https://cushy.rs/$ref-name$/guide/
[discussions]: https://github.com/khonsulabs/cushy/discussions
[discord]: https://discord.khonsulabs.com/

19
README.md
View file

@ -2,7 +2,8 @@
![Cushy is considered alpha and unsupported](https://img.shields.io/badge/status-alpha-orange) ![Cushy is considered alpha and unsupported](https://img.shields.io/badge/status-alpha-orange)
[![crate version](https://img.shields.io/crates/v/cushy.svg)](https://crates.io/crates/cushy) [![crate version](https://img.shields.io/crates/v/cushy.svg)](https://crates.io/crates/cushy)
[![Documentation for `main` branch](https://img.shields.io/badge/docs-main-informational)](https://khonsu.dev/cushy/main/docs/cushy/) [![Documentation for `main`](https://img.shields.io/badge/docs-main-informational)](https://cushy.rs/main/docs/cushy/)
[![Cushy User's Guide](https://img.shields.io/badge/user%27s%20guide-main-informational)][guide]
Cushy is an experimental Graphical User Interface (GUI) crate for the Rust Cushy is an experimental Graphical User Interface (GUI) crate for the Rust
programming language. It features a reactive data model and aims to enable programming language. It features a reactive data model and aims to enable
@ -48,9 +49,12 @@ fn main() -> cushy::Result {
} }
``` ```
A great way to learn more about Cushy is to explore the [examples Here are some ways to learn more about Cushy:
directory][examples]. Nearly every feature in Cushy was initially tested by
creating an example. - Explore the [examples directory][examples]. Nearly every feature in Cushy was
initially tested by creating an example.
- Browse the [user's guide][guide].
- Ask questions [in Discussions][discussions] or [on Discord][discord].
## Project Status ## Project Status
@ -65,8 +69,8 @@ and problem it aims to solve. Doing so will help prevent friction in merging
pull requests, as it ensures changes fit the vision the maintainers have for pull requests, as it ensures changes fit the vision the maintainers have for
Cushy. Cushy.
[widget]: https://khonsu.dev/cushy/main/docs/cushy/widget/trait.Widget.html [widget]: https://cushy.rs/main/docs/cushy/widget/trait.Widget.html
[widgets]: https://khonsu.dev/cushy/main/docs/cushy/widgets/index.html [widgets]: https://cushy.rs/main/docs/cushy/widgets/index.html
[button-example]: https://github.com/khonsulabs/cushy/tree/main/examples/basic-button.rs [button-example]: https://github.com/khonsulabs/cushy/tree/main/examples/basic-button.rs
[examples]: https://github.com/khonsulabs/cushy/tree/main/examples/ [examples]: https://github.com/khonsulabs/cushy/tree/main/examples/
[kludgine]: https://github.com/khonsulabs/kludgine [kludgine]: https://github.com/khonsulabs/kludgine
@ -78,6 +82,9 @@ Cushy.
[arboard]: https://github.com/1Password/arboard [arboard]: https://github.com/1Password/arboard
[ecton]: https://github.com/khonsulabs/ecton [ecton]: https://github.com/khonsulabs/ecton
[issues]: https://github.com/khonsulabs/cushy/issues [issues]: https://github.com/khonsulabs/cushy/issues
[guide]: https://cushy.rs/main/guide/
[discussions]: https://github.com/khonsulabs/cushy/discussions
[discord]: https://discord.khonsulabs.com/
## Open-source Licenses ## Open-source Licenses