Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note on examples #597

Merged
merged 2 commits into from
Sep 25, 2024
Merged

Add note on examples #597

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f3500b
Add note on examples
almarklein Sep 24, 2024
e38400f
Merge branch 'main' into examples
almarklein Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# The wgpu Examples

Please note that the examples you see on Github may not be compatible with the
wgpu version you've installed on your system.

You can:

* View the examples in the online docs:
* TODO: the gallery is not implemented yet.
* View the examples at the version you've installed:
* In the url `https://github.com/pygfx/wgpu-py/tree/main/examples` you can replace `main`
with e.g. `vx.y.z` to see the compatible version.
* Install the bleeding edge version of wgpu-py:
* Checkout the [developers section](https://github.com/pygfx/wgpu-py?tab=readme-ov-file#developers) in the readme.