From 31de0bc458c7c6594af7534190ac77b30afdcf1b Mon Sep 17 00:00:00 2001 From: Jonathan Johnson Date: Sat, 6 Jan 2024 11:01:56 -0800 Subject: [PATCH] Fixing asset link And a little more filler --- guide/src/about.md | 21 ++++++++++++++++++++- guide/src/intro.md | 13 ++++++++++++- guide/src/widgets/layout/align.md | 4 +--- 3 files changed, 33 insertions(+), 5 deletions(-) diff --git a/guide/src/about.md b/guide/src/about.md index 4b51d64..729bcd4 100644 --- a/guide/src/about.md +++ b/guide/src/about.md @@ -1 +1,20 @@ -# About +# About Cushy + +Cushy is a Graphical User Interface (GUI) crate for the [Rust programming +language][rust]. It runs natively utilizing [wgpu][wgpu] to render +consistently-styled, cross-platform applications using hardware acceleration +when available. It does not utilize any existing widget libraries. + +Cushy's high-level goals are to be: + +- Easy-to-use. +- Flexible. +- Predictable. +- Efficient. +- Accessible. + +Being so early in development, Cushy has not yet achieved all of its goals, +especially with regards to accessibility. + +[rust]: +[wgpu]: diff --git a/guide/src/intro.md b/guide/src/intro.md index f82f58e..fcde68f 100644 --- a/guide/src/intro.md +++ b/guide/src/intro.md @@ -1 +1,12 @@ -# Welcome +# Introduction + +> **WARNING:** Cushy is in early alpha. This guide doubly so. + +This is a user's guide for [Cushy][cushy], a [Rust][rust] GUI crate. The +[documentation][docs] is a great resource for finding information about specific +functionality quickly. This guide is aimed to providing an example-rich +walkthrough of how to use and extend Cushy. + +[cushy]: +[rust]: +[docs]: <{{docs}}> diff --git a/guide/src/widgets/layout/align.md b/guide/src/widgets/layout/align.md index 685c9bd..0c85d00 100644 --- a/guide/src/widgets/layout/align.md +++ b/guide/src/widgets/layout/align.md @@ -1,7 +1,5 @@ # Aligning Widgets -{{#title Align - Layout Widgets - Cushy User's Guide}} - The [`Align`][align] widget positions a child widget within its parent. It supports both horizontal and vertical alignment. @@ -18,7 +16,7 @@ to the parent's matching edge. ## Examples -![Align widget example](/examples/align.png) +![Align widget example](../../examples/align.png) The `content()` function in each of these snippets is a [`Space`][space] widget occupying at least 32px squared: