Skip to content

Make README example self-contained#339

Open
madsmtm wants to merge 1 commit intomasterfrom
madsmtm/readme-example
Open

Make README example self-contained#339
madsmtm wants to merge 1 commit intomasterfrom
madsmtm/readme-example

Conversation

@madsmtm
Copy link
Member

@madsmtm madsmtm commented Feb 11, 2026

I'm generally against utility helpers in examples, example code is allowed to contain duplication.

At the very least, we shouldn't use a utility module in the first example that users see, we should use the actual Winit API to show how to manage the surface between suspend/resume calls. This PR fixes that (we can consider changing the other examples later).

@madsmtm madsmtm added the documentation Improvements or additions to documentation label Feb 11, 2026
@madsmtm madsmtm changed the title Improve README example Make README example self-contained Feb 11, 2026
@madsmtm madsmtm force-pushed the madsmtm/readme-example branch from 6d75db3 to fa540ce Compare February 11, 2026 10:16
Don't use a utility module in the first example that users see, use the
actual Winit API.
@madsmtm madsmtm force-pushed the madsmtm/readme-example branch from fa540ce to 731fb8b Compare February 11, 2026 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

1 participant