From e72435bea21d1540c5dbc7014eff7d4de6e14e13 Mon Sep 17 00:00:00 2001 From: Ramen2X Date: Sat, 11 Jan 2025 16:17:39 -0500 Subject: [PATCH] add note regarding usage (#56) [skip ci] --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 0227601c..10a56e6b 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,12 @@ To achieve our goal of platform independence, we need to replace any Windows-onl This project uses the [CMake](https://cmake.org/) build system, which allows for a high degree of versatility regarding compilers and development environments. Please refer to the [GitHub action](/.github/workflows//build.yml) for guidance. +## Usage + +As it stands, this project is currently not ready to be played by end users. The nature of the porting process can leave the game unstable or even completely unplayable at times while the migration of game and engine code to modern APIs continues. For this reason, there is currently no support for running any executables produced by this project outside of a development environment, and no guarantees of playability or stability are provided. + +If you are a developer who feels like you can assist with porting efforts; especially if you have experience working with standard 3D libraries, please check Contributing and get in contact with our team on Matrix for help with setup. + ## Contributing If you're interested in helping or contributing to this project, check out the [CONTRIBUTING](/CONTRIBUTING.md) page.