gpui-tutorial README

The project's README from github.com/hedge-ops/gpui-tutorial. As one markdown file: README.md.

gpui Tutorial

Summary

GPUI is a GPU-accelerated UI framework created by the makers of Zed, written in Rust. It's available on crates.io and licensed under the Apache license, making it usable by commercial projects.

This tutorial uses gpui 0.2.2. To add it to your project:

[dependencies]
gpui = "0.2.2"

Currently there is not a lot of official documentation, so this tutorial aims to take you through the basics of the framework to get started on your own project.

Sections

To understand the basic terms, see the dictionary. To read more on how I learned the framework, see resources.

Future Topics

Missing

Outstanding Questions

gpui-tutorial (hedge-ops/gpui-tutorial)

Searching Database…

What is this?A hands-on tutorial for GPUI, the GPU-accelerated UI framework written in Rust by the makers of the Zed editor. It walks you from Hello World up to building your own first app.
Is GPUI the framework itself, or a tutorial about it?A tutorial — the framework itself ships separately via crates.io. The guide exists because official GPUI documentation is still scarce.
How do I go from this repo to a running gpui app?Start with section 00 to make sure your Rust setup is solid, add gpui 0.2.2 from crates.io to your project, then build the Hello World app from section 01.
Do I need to know Rust before starting?Yes — the tutorial opens with a prerequisites section that makes sure you know Rust and have your machine set up properly before any code.
Is the tutorial finished, or still being written?Still a work in progress: the actions-and-keybindings chapter is marked WIP, and topics like menus, shared state and animation are listed only as future plans.
Is GPUI safe to use in commercial projects?The README notes GPUI is Apache-licensed and explicitly usable by commercial projects. The tutorial repo itself states no license of its own in its metadata.
What do the sections actually walk me through?Hello World first, then a Likes Counter where clicking a button updates state, then the button refactored into a reusable component, then keyboard shortcuts via actions.
Does it explain GPUI's terminology, or do I have to guess?There is a dictionary of basic terms covering the framework's vocabulary, plus a resources page describing how the author learned GPUI himself.
Who makes GPUI, and what is Zed?GPUI comes from the team behind the Zed editor, with performance as its top priority. The tutorial itself is community-written by a single author, not official documentation.
Which topics are planned but not covered yet?Menus wired to actions, conditional disabled states, shared state with Models, icon and input controls, an app icon asset, and animation are all listed as future topics.
Creator
hedge-ops
Size
1.1 MB
Stars
104
Updated
CommitApr 25
Age
2y
Commits · 90 Days