diff --git a/README.md b/README.md index 537de2b..3034a5e 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ # Better-Minimal-WebGL-Template + +Minimal WebGL build template. + +## Features + +- Scales canvas to fit the window horizontally + vertically while maintaining aspect ratio (can be disabled) +- Centers canvas in window +- Customizable background + +## To use + +1. Download and unzip +2. Copy the `WebGLTemplates` folder into your project's `Assets` folder +3. File -> Build Settings... -> WebGL -> Player Settings... -> Select the `BetterMinimal` template +4. (Optional) Customize colour in the `Background` field; enter `false` in the `Scale to fit` field to disable scaling + +Ideal for embedding on sites like itch.io which provide an external full-screen button.