From 96e5b2ca48c22426165a06b0f17e23ee9db8c908 Mon Sep 17 00:00:00 2001 From: Robin KAY Date: Tue, 23 Aug 2022 22:41:08 +0100 Subject: [PATCH] Add documentation on feature flags to README. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 0a848c6..4a931fc 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,13 @@ cargo run --example shapes | 0.1.x | 0.7.x | | 0.2.x | 0.8.x | +## Features + +- `align16` _(default)_ - Aligns uniform structs to 16-byte boundaries. +This is required by WebGL and some downlevel GPUs. +- `bevy_ui` _(default)_ - Adds a render graph edge to prevent clashing with the UI. +This adds a dependency on the `bevy_ui` crate and can disabled if it is not used. + ## Licence This crate is licensed under the Apache License, Version 2.0 (see