From 66103d128eec540db2772fb0b51d1218c765832f Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Wed, 5 Apr 2023 03:08:09 -0700 Subject: [PATCH] ecs: add experimental warning Signed-off-by: Stephen Gutekanst --- libs/ecs/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/libs/ecs/README.md b/libs/ecs/README.md index 64ce9105..4f135916 100644 --- a/libs/ecs/README.md +++ b/libs/ecs/README.md @@ -2,6 +2,14 @@ `mach/ecs` is an Entity Component System for Zig built from first-principles. +## Experimental + +This is an _experimental_ Mach library, according to our [stability guarantees](https://machengine.org/next/docs/libs/): + +> Experimental libraries may have their APIs change without much notice, and you may have to look at recent changes in order to update your code. + +[Why this library is not declared stable yet](https://machengine.org/next/docs/libs/experimental/#ecs) + ## Design principles: * Initially a 100% clean-room implementation, working from first-principles. Later informed by research into how other ECS work, with advice from e.g. Bevy and Flecs authors at different points (thank you!)