From b649bc4ad68e114e4de9eba6356fccea6103af15 Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Wed, 5 Apr 2023 03:07:18 -0700 Subject: [PATCH] core: add experimental warning Signed-off-by: Stephen Gutekanst --- libs/core/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/libs/core/README.md b/libs/core/README.md index 1c81e601..08971ccd 100644 --- a/libs/core/README.md +++ b/libs/core/README.md @@ -2,6 +2,14 @@ This repository is a separate copy of the same library in the [main Mach repository](https://github.com/hexops/mach), and is automatically kept in sync, so that anyone can use this library in their own project if they like! +## 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/#core) + ## Window+Input+GPU, nothing else. mach/core provides the power of Vulkan, DirectX, Metal, and modern OpenGL in a single concise graphics API - by compiling Google Chrome's WebGPU implementation natively via Zig (no cmake/ninja/gn/etc) into a single static library.