diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..a8e2ce58 --- /dev/null +++ b/examples/README.md @@ -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. +