Skip to content

Commit

Permalink
Add note on examples (#597)
Browse files Browse the repository at this point in the history
  • Loading branch information
almarklein authored Sep 25, 2024
1 parent 5a0e691 commit bd8dab7
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions examples/README.md
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.

0 comments on commit bd8dab7

Please sign in to comment.