From aae8da391ca9311164fbeac8c96f896c7652a6ac Mon Sep 17 00:00:00 2001 From: Ramen2X Date: Sat, 21 Jun 2025 18:55:57 -0400 Subject: [PATCH] add usage section to readme (#384) [skip ci] --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 58606c4c..a0787f52 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,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//ci.yml) for guidance. +## Usage + +**An existing copy of LEGO Island is required to use this project.** + +As it stands, the builds provided in the Releases tab are for developers; as such, they may not work properly for end-users. Work is currently ongoing to create workable release builds ready for gameplay and general use by end-users. If you are technically inclined, you may find it easiest to compile the project yourself to get it running at this current point in time. + ## Contributing If you're interested in helping or contributing to this project, check out the [CONTRIBUTING](/CONTRIBUTING.md) page.