guido 0.12.0

A reactive Rust GUI library using wgpu for Wayland layer shell widgets
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

# Installation

This guide walks you through setting up Guido for development.

## System Requirements

### Wayland Compositor

Guido requires a Wayland compositor with layer shell protocol support. Compatible compositors include:

- **Sway** - i3-compatible Wayland compositor
- **Hyprland** - Dynamic tiling Wayland compositor
- **river** - Dynamic tiling Wayland compositor
- **wayfire** - 3D Wayland compositor

> **Note:** X11 is not supported. Guido is designed specifically for Wayland layer shell applications.

### System Dependencies

Install the required development libraries for your distribution:

**Arch Linux:**
```bash
sudo pacman -S wayland wayland-protocols libxkbcommon
```

**Debian/Ubuntu:**
```bash
sudo apt install libwayland-dev libxkbcommon-dev
```

**Fedora:**
```bash
sudo dnf install wayland-devel libxkbcommon-devel
```

## Adding Guido to Your Project

### New Project

Create a new Rust project and add Guido:

```bash
cargo new my-app
cd my-app
cargo add guido
```

### Existing Project

Add Guido to your `Cargo.toml`:

```toml
[dependencies]
guido = "0.1"
```

Or use cargo:

```bash
cargo add guido
```

## Verifying Installation

Create a minimal test application to verify everything works:

```rust,no_run
# extern crate guido;
// src/main.rs
use guido::prelude::*;

fn main() {
    App::new().run(|app| {
        app.add_surface(
            SurfaceConfig::new()
                .width(200)
                .height(100)
                .background_color(Color::rgb(0.1, 0.1, 0.15)),
            || {
                container()
                    .padding(20.0)
                    .background(Color::rgb(0.2, 0.3, 0.4))
                    .child(container().child(text("Hello, Guido!").color(Color::WHITE)))
            },
        );
    });
}
```

Run the application:

```bash
cargo run
```

If you see a small window with "Hello, Guido!" text, the installation is successful.

## Troubleshooting

### "No Wayland display" Error

Ensure you're running in a Wayland session, not X11:
```bash
echo $XDG_SESSION_TYPE  # Should output "wayland"
```

### Compositor Doesn't Support Layer Shell

Some Wayland compositors (like GNOME's Mutter) don't support the layer shell protocol. Use a compatible compositor listed above.

### Missing Libraries

If you get linker errors about missing libraries, ensure the system dependencies are installed. The error messages usually indicate which library is missing.

## Next Steps

Now that Guido is installed, continue to the [Hello World](hello-world.md) tutorial to build your first application.